Skip to main content

Config

Struct Config 

Source
pub struct Config {
Show 14 fields pub node: NodeConfig, pub interface: InterfaceConfig, pub discovery: DiscoveryConfig, pub mesh: MeshConfig, pub transport: TransportConfig, pub routing: RoutingConfig, pub gateway: GatewayConfig, pub relay: RelayConfig, pub security: SecurityConfig, pub wifi_direct: WifiDirectConfig, pub bluetooth: BluetoothConfig, pub bluetooth_rfcomm: BluetoothRfcommConfig, pub messaging: MessagingConfig, pub peers: Vec<PeerConfig>,
}
Expand description

Top-level configuration loaded from the node TOML file.

Fields§

§node: NodeConfig

Identity and local state settings for this node.

§interface: InterfaceConfig

TUN interface settings for the mesh dataplane.

§discovery: DiscoveryConfig

LAN peer discovery settings.

§mesh: MeshConfig

Optional private-mesh membership settings. Absent or mode = "open" → open mesh (any peer can connect; default behaviour). When configured with mode = "private" and a passphrase, only peers that derive the same mesh secret can complete the handshake or decrypt discovery advertisements. See MeshConfig for the schema.

§transport: TransportConfig

Peer-to-peer transport settings.

§routing: RoutingConfig

Route propagation and expiry settings.

§gateway: GatewayConfig

Internet gateway behaviour and NAT settings.

§relay: RelayConfig

Relay forwarding settings. When enabled this node forwards traffic for other mesh peers.

§security: SecurityConfig

Key material and encryption policy settings.

§wifi_direct: WifiDirectConfig

Wi-Fi Direct (IEEE 802.11 P2P) peer discovery and group formation settings.

§bluetooth: BluetoothConfig

Bluetooth PAN peer link monitoring and address handoff settings.

§bluetooth_rfcomm: BluetoothRfcommConfig

Bluetooth RFCOMM direct-channel discovery and TCP bridge settings.

§messaging: MessagingConfig

User-to-user encrypted messaging settings, including broadcast policy.

§peers: Vec<PeerConfig>

Statically configured peers. Optional — nodes can rely entirely on discovery when empty.

Implementations§

Source§

impl Config

Source

pub fn load(path: &Path) -> Result<Self, PimError>

Load configuration from a TOML file.

Source

pub fn from_toml_str(s: &str) -> Result<Self, PimError>

Parse configuration from a TOML string.

Source

pub fn to_toml_string(&self) -> Result<String, PimError>

Serialize configuration to a TOML string.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · 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<'de> Deserialize<'de> for Config

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 FromStr for Config

Source§

type Err = PimError

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl PartialEq for Config

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
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 StructuralPartialEq for Config

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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