Struct brane_cfg::infra::InfraFile

pub struct InfraFile { /* private fields */ }

Defines a “handle” to the document that contains the Brane instance layout.

It is recommended to only load when used, to allow system admins to update the file during runtime.

Implementations

impl InfraFile

pub fn new(locations: HashMap<String, InfraLocation>) -> Self

Constructor for the InfraFile.

Arguments

• locations: The map of location IDs to InfraLocations around which to initialize this InfraFile.

Returns

A new InfraFile instance.

pub fn get(&self, name: impl AsRef<str>) -> Option<&InfraLocation>

Returns the metadata for the location with the given name.

Arguments

• name: The name of the location to retrieve.

Returns

The InfraLocation of the location that was referenced by the name, or else None if it didn’t exist.

pub fn iter(&self) -> Iter<'_, String, InfraLocation>

Returns an iterator-by-reference over the internal map.

pub fn iter_mut(&mut self) -> IterMut<'_, String, InfraLocation>

Returns a muteable iterator-by-reference over the internal map.

pub fn len(&self) -> usize

Returns the number of locations in this file.

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for InfraFile

fn clone(&self) -> InfraFile

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InfraFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InfraFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> IntoIterator for &'a InfraFile

type IntoIter = Iter<'a, String, InfraLocation>

Which kind of iterator are we turning this into?

type Item = (&'a String, &'a InfraLocation)

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut InfraFile

type IntoIter = IterMut<'a, String, InfraLocation>

Which kind of iterator are we turning this into?

type Item = (&'a String, &'a mut InfraLocation)

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for InfraFile

type IntoIter = IntoIter<String, InfraLocation>

Which kind of iterator are we turning this into?

type Item = (String, InfraLocation)

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Serialize for InfraFile

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'de> YamlInfo<'de> for InfraFile