Struct aether_lib::config::Config

source · [−]

pub struct Config {
    pub aether: AetherConfig,
    pub handshake: HandshakeConfig,
    pub link: LinkConfig,
}

Expand description

Structure to represent configuration options for aether_lib

Fields

aether: AetherConfig

Configuration for peer module

handshake: HandshakeConfig

Configuration for handshake module

link: LinkConfig

Configuration for link module

Implementations

source

impl Config

source

pub fn from_file(file_path: &Path) -> Result<Config, AetherError>

Returns configuration read from file_path Configuration file must be in YAML format This may return an AetherError if the file is not present or if the file is not correctly formated as yaml

Examples

use aether_lib::config::Config;
use std::path::Path;

// For a file located inside /home/user/aether_config.yaml we can construct
// a path
let path = Path::new("/home/user/aether_config.yaml");

let config = Config::from_file(&path);

source

pub fn get_config() -> Result<Config, AetherError>

Returns configuration read from the default configuration file If default configuration file is not found, the default internal configuration is returned

Examples

use aether_lib::config::Config;
let config = Config::get_config();

Trait Implementations

source

impl Clone for Config

source

fn clone(&self) -> Config

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Config

source

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

Formats the value using the given formatter. Read more

source

impl Default for Config

source

fn default() -> Config

Returns the “default value” for a type. Read more

source

impl<'de> Deserialize<'de> for Config where
Config: Default,

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl PartialEq<Config> for Config

source

fn eq(&self, other: &Config) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

source

fn ne(&self, other: &Config) -> bool

This method tests for !=.

source

impl Serialize for Config

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

source

impl TryFrom<Config> for String

type Error = Error

The type returned in the event of a conversion error.

source

fn try_from(value: Config) -> Result<Self, Self::Error>

Performs the conversion.

source

impl TryFrom<String> for Config

type Error = Error

The type returned in the event of a conversion error.

source

fn try_from(string: String) -> Result<Self, Self::Error>

Performs the conversion.

source

impl Copy for Config

source

impl StructuralPartialEq for Config

Auto Trait Implementations

impl RefUnwindSafe for Config

impl Send for Config

impl Sync for Config

impl Unpin for Config

impl UnwindSafe for Config

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

source

Struct aether_lib::config::Config

Fields

Implementations

impl Config

pub fn from_file(file_path: &Path) -> Result<Config, AetherError>

pub fn get_config() -> Result<Config, AetherError>

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

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

impl Debug for Config

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

impl Default for Config

fn default() -> Config

impl<'de> Deserialize<'de> for Config where Config: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where __D: Deserializer<'de>,

impl PartialEq<Config> for Config

fn eq(&self, other: &Config) -> bool

fn ne(&self, other: &Config) -> bool

impl Serialize for Config

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

impl TryFrom<Config> for String

type Error = Error

fn try_from(value: Config) -> Result<Self, Self::Error>

impl TryFrom<String> for Config

type Error = Error

fn try_from(string: String) -> Result<Self, Self::Error>

impl Copy for Config

impl StructuralPartialEq for Config

Auto Trait Implementations

impl RefUnwindSafe for Config

impl Send for Config

impl Sync for Config

impl Unpin for Config

impl UnwindSafe for Config

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,

impl<'de> Deserialize<'de> for Config where
Config: Default,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,