Enum brane_cfg::node::NodeSpecificConfig

pub enum NodeSpecificConfig {
    Central(CentralConfig),
    Worker(WorkerConfig),
    Proxy(ProxyConfig),
}

Defines the services from the various nodes.

Variants

Central(CentralConfig)

Defines the services for the central node.

Worker(WorkerConfig)

Defines the services for the worker node.

Proxy(ProxyConfig)

Defines the services for the proxy node.

Implementations

impl NodeSpecificConfig

pub fn kind(&self) -> NodeKind

Returns the kind of this config.

pub fn is_central(&self) -> bool

Returns if this NodeSpecificConfig is a NodeSpecificConfig::Central.

Returns

True if it is, or false otherwise.

pub fn central(&self) -> &CentralConfig

Provides immutable access to the central-node specific configuration.

Returns

A reference to the internal CentralConfig struct.

Panics

This function panics if we were not NodeSpecificConfig::Central. If you are looking for a more user-friendly version, check NodeSpecificConfig::try_central() instead.

pub fn central_mut(&mut self) -> &mut CentralConfig

Provides mutable access to the central-node specific configuration.

Returns

A mutable reference to the internal CentralConfig struct.

Panics

This function panics if we were not NodeSpecificConfig::Central. If you are looking for a more user-friendly version, check NodeSpecificConfig::try_central_mut() instead.

pub fn into_central(self) -> CentralConfig

Returns the internal central-node specific configuration.

Returns

The internal CentralConfig struct.

Panics

This function panics if we were not NodeSpecificConfig::Central. If you are looking for a more user-friendly version, check NodeSpecificConfig::try_into_central() instead.

pub fn try_central(&self) -> Option<&CentralConfig>

Provides immutable access to the central-node specific configuration.

Returns

A reference to the internal CentralConfig struct if we were a NodeSpecificConfig::Central. Will return None otherwise.

pub fn try_central_mut(&mut self) -> Option<&mut CentralConfig>

Provides mutable access to the central-node specific configuration.

Returns

A mutable reference to the internal CentralConfig struct if we were a NodeSpecificConfig::Central. Will return None otherwise.

pub fn try_into_central(self) -> Option<CentralConfig>

Returns the internal central-node specific configuration.

Returns

The internal CentralConfig struct if we were a NodeSpecificConfig::Central. Will return None otherwise.

pub fn is_worker(&self) -> bool

Returns if this NodeSpecificConfig is a NodeSpecificConfig::Worker.

Returns

True if it is, or false otherwise.

pub fn worker(&self) -> &WorkerConfig

Provides immutable access to the worker-node specific configuration.

Returns

A reference to the internal WorkerConfig struct.

Panics

This function panics if we were not NodeSpecificConfig::Worker. If you are looking for a more user-friendly version, check NodeSpecificConfig::try_worker() instead.

pub fn worker_mut(&mut self) -> &mut WorkerConfig

Provides mutable access to the worker-node specific configuration.

Returns

A mutable reference to the internal WorkerConfig struct.

Panics

This function panics if we were not NodeSpecificConfig::Worker. If you are looking for a more user-friendly version, check NodeSpecificConfig::try_worker_mut() instead.

pub fn into_worker(self) -> WorkerConfig

Returns the internal worker-node specific configuration.

Returns

The internal WorkerConfig struct.

Panics

This function panics if we were not NodeSpecificConfig::Worker. If you are looking for a more user-friendly version, check NodeSpecificConfig::try_into_worker() instead.

pub fn try_worker(&self) -> Option<&WorkerConfig>

Provides immutable access to the worker-node specific configuration.

Returns

A reference to the internal WorkerConfig struct if we were a NodeSpecificConfig::Worker. Will return None otherwise.

pub fn try_worker_mut(&mut self) -> Option<&mut WorkerConfig>

Provides mutable access to the worker-node specific configuration.

Returns

A mutable reference to the internal WorkerConfig struct if we were a NodeSpecificConfig::Worker. Will return None otherwise.

pub fn try_into_worker(self) -> Option<WorkerConfig>

Returns the internal worker-node specific configuration.

Returns

The internal WorkerConfig struct if we were a NodeSpecificConfig::Worker. Will return None otherwise.

pub fn is_proxy(&self) -> bool

Returns if this NodeSpecificConfig is a NodeSpecificConfig::Proxy.

Returns

True if it is, or false otherwise.

pub fn proxy(&self) -> &ProxyConfig

Provides immutable access to the proxy-node specific configuration.

Returns

A reference to the internal ProxyConfig struct.

Panics

This function panics if we were not NodeSpecificConfig::Proxy. If you are looking for a more user-friendly version, check NodeSpecificConfig::try_proxy() instead.

pub fn proxy_mut(&mut self) -> &mut ProxyConfig

Provides mutable access to the proxy-node specific configuration.

Returns

A mutable reference to the internal ProxyConfig struct.

Panics

This function panics if we were not NodeSpecificConfig::Proxy. If you are looking for a more user-friendly version, check NodeSpecificConfig::try_proxy_mut() instead.

pub fn into_proxy(self) -> ProxyConfig

Returns the internal proxy-node specific configuration.

Returns

The internal ProxyConfig struct.

Panics

This function panics if we were not NodeSpecificConfig::Proxy. If you are looking for a more user-friendly version, check NodeSpecificConfig::try_into_proxy() instead.

pub fn try_proxy(&self) -> Option<&ProxyConfig>

Provides immutable access to the proxy-node specific configuration.

Returns

A reference to the internal ProxyConfig struct if we were a NodeSpecificConfig::Proxy. Will return None otherwise.

pub fn try_proxy_mut(&mut self) -> Option<&mut ProxyConfig>

Provides mutable access to the proxy-node specific configuration.

Returns

A mutable reference to the internal ProxyConfig struct if we were a NodeSpecificConfig::Proxy. Will return None otherwise.

pub fn try_into_proxy(self) -> Option<ProxyConfig>

Returns the internal proxy-node specific configuration.

Returns

The internal ProxyConfig struct if we were a NodeSpecificConfig::Proxy. Will return None otherwise.

Trait Implementations

impl Clone for NodeSpecificConfig

fn clone(&self) -> NodeSpecificConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeSpecificConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NodeSpecificConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EnumDebug for NodeSpecificConfig

fn type_name() -> &'static str

Returns the static name of the type used for EnumDebug-printing.

fn variant_names() -> &'static [&'static str]

Returns all variants in the trait as a list of names.

fn variant_name(&self) -> &'static str

Returns the static name of the variant.

fn variant(&self) -> EnumDebugFormatter<'_, Self>

Returns a formatter for this enum that writes its variant name.

fn variants() -> Copied<Iter<'static, &'static str>>

Returns an iterator over all variants in this enum.

impl Serialize for NodeSpecificConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.