Struct NetworksFileConfig

pub struct NetworksFileConfig {
    pub networks: Vec<NetworkFileConfig>,
    /* private fields */
}

Represents the complete configuration for all defined networks.

This structure holds configurations loaded from a file or a directory of files and provides methods to validate and process them, including resolving inheritance.

Fields

networks: Vec<NetworkFileConfig>

Implementations

impl NetworksFileConfig

pub fn new(networks: Vec<NetworkFileConfig>) -> Result<Self, ConfigFileError>

Creates a new NetworksFileConfig instance from a vector of network configurations.

Returns

• Ok(Self) if all network names are unique within their respective types and the instance is successfully created.
• Err(ConfigFileError) if duplicate network names are found within the same network type.

pub fn get_network( &self, network_type: ConfigFileNetworkType, name: &str, ) -> Option<&NetworkFileConfig>

Retrieves a network configuration by its network type and name.

Arguments

• network_type - The type of the network to retrieve.
• name - The name of the network to retrieve.

Returns

• Some(&NetworkFileConfig) if a network with the given type and name exists.
• None if no network with the given type and name is found.

pub fn flatten(&self) -> Result<NetworksFileConfig, ConfigFileError>

Builds a new set of networks with all inheritance chains resolved and flattened.

This method processes all networks and their inheritance relationships to produce a set of fully expanded network configurations where each network includes all properties from its parent networks, with any overrides applied.

Returns

• Result<NetworksFileConfig, ConfigFileError> containing either the flattened configuration or an error if any inheritance issues are encountered.

pub fn validate(&self) -> Result<(), ConfigFileError>

Validates the entire networks configuration structure.

Returns

• Ok(()) if the entire configuration is valid.
• Err(ConfigFileError) if any validation fails (duplicate names, invalid inheritance, incompatible inheritance types, or errors from individual network validations).

pub fn iter(&self) -> impl Iterator<Item = &NetworkFileConfig>

Returns an iterator over all networks.

pub fn len(&self) -> usize

Returns the number of networks in the configuration.

pub fn is_empty(&self) -> bool

Returns true if there are no networks in the configuration.

pub fn networks_by_type( &self, network_type: ConfigFileNetworkType, ) -> impl Iterator<Item = &NetworkFileConfig>

Filters networks by type.

pub fn network_names(&self) -> impl Iterator<Item = &str>

Gets all network names.

pub fn first(&self) -> Option<&NetworkFileConfig>

Returns the first network in the configuration.

Returns

• Some(&NetworkFileConfig) if there is at least one network.
• None if the configuration is empty.

pub fn get(&self, index: usize) -> Option<&NetworkFileConfig>

Returns a reference to the network at the given index.

Arguments

• index - The index of the network to retrieve.

Returns

• Some(&NetworkFileConfig) if a network exists at the given index.
• None if the index is out of bounds.

Trait Implementations

impl Clone for NetworksFileConfig

fn clone(&self) -> NetworksFileConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NetworksFileConfig

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

Formats the value using the given formatter.

impl Default for NetworksFileConfig

fn default() -> NetworksFileConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NetworksFileConfig

Custom deserialization logic for NetworksFileConfig.

This allows NetworksFileConfig to be created from either a direct list of network configurations, a path string pointing to a directory of configuration files, or null/missing for the default path (“./config/networks”).

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Index<usize> for NetworksFileConfig

type Output = NetworkFileConfig

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Serialize for NetworksFileConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.