Struct brane_ctl::old_configs::v1_0_0::node::NodeConfig

pub struct NodeConfig {
    pub hosts: HashMap<String, IpAddr>,
    pub proxy: Option<Address>,
    pub names: CommonNames,
    pub paths: CommonPaths,
    pub ports: CommonPorts,
    pub services: CommonServices,
    pub node: NodeKindConfig,
}

Defines a node.json file that describes the environment layout of a node (what type it is, its location ID, where to find folders/services, etc).

Fields

hosts: HashMap<String, IpAddr>

Defines any custom hostname -> IP mappings.

proxy: Option<Address>

Defines the proxy address to use for control messages, if any.

names: CommonNames

Defines the names of the services that occur on every kind of node.

paths: CommonPaths

Defines the paths used by various services that occur on every kind of node.

ports: CommonPorts

Defines the ports where various services hosts themselves that occur on any kind of node.

services: CommonServices

Defines service addresses that occur on any kind of node.

node: NodeKindConfig

NodeKind-specific configuration options,

Implementations

impl NodeConfig

pub fn from_path(path: impl AsRef<Path>) -> Result<Self, NodeConfigError>

Constructor for the NodeConfig that reads it from the given path.

Arguments

• path: The path to read the NodeConfig from.

Returns

A new NodeConfig instance with the contents defined in the file.

Errors

This function errors if the given file cannot be read or has an invalid format.

pub fn to_path(&self, path: impl AsRef<Path>) -> Result<(), NodeConfigError>

Writes the NodeConfig to the given path.

Arguments

• path: The path to write the NodeConfig to.

Returns

Nothing, but does obviously create a new file with this NodeConfig’s contents.

Errors

This function errors if the given file cannot be written or we failed to serialize ourselves.

pub fn to_writer(&self, writer: impl Write) -> Result<(), NodeConfigError>

Writes the NodeConfig to the given writer.

Arguments

• writer: The path to write the NodeConfig to.

Returns

Nothing, but does obviously populate the given writer with its own serialized contents.

Errors

This function errors if we failed to write or failed to serialize ourselves.

Trait Implementations

impl AsRef<NodeConfig> for NodeConfig

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for NodeConfig

fn clone(&self) -> NodeConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NodeConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&NodeConfig> for NodeConfig

fn from(value: &NodeConfig) -> Self

Converts to this type from the input type.

impl From<&mut NodeConfig> for NodeConfig

fn from(value: &mut NodeConfig) -> Self

Converts to this type from the input type.

impl Serialize for NodeConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.