Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub node: NodeConfig,
    pub tun: TunConfig,
    pub dns: DnsConfig,
    pub transports: TransportsConfig,
    pub peers: Vec<PeerConfig>,
    pub gateway: Option<GatewayConfig>,
}
Expand description

Root configuration structure.

Fields§

§node: NodeConfig

Node configuration (node.*).

§tun: TunConfig

TUN interface configuration (tun.*).

§dns: DnsConfig

DNS responder configuration (dns.*).

§transports: TransportsConfig

Transport instances (transports.*).

§peers: Vec<PeerConfig>

Static peers to connect to (peers).

§gateway: Option<GatewayConfig>

Gateway configuration (gateway).

Implementations§

Source§

impl Config

Source

pub fn new() -> Self

Create a new empty configuration.

Source

pub fn load() -> Result<(Self, Vec<PathBuf>), ConfigError>

Load configuration from the standard search paths.

Files are loaded in reverse priority order and merged:

  1. /etc/fips/fips.yaml (loaded first, lowest priority)
  2. ~/.config/fips/fips.yaml (user config)
  3. ./fips.yaml (loaded last, highest priority)

Returns a tuple of (config, paths_loaded) where paths_loaded contains the paths that were successfully loaded.

Source

pub fn load_from_paths( paths: &[PathBuf], ) -> Result<(Self, Vec<PathBuf>), ConfigError>

Load configuration from specific paths.

Paths are processed in order, with later paths overriding earlier ones.

Source

pub fn load_file(path: &Path) -> Result<Self, ConfigError>

Load configuration from a single file.

Source

pub fn search_paths() -> Vec<PathBuf>

Get the standard search paths in priority order (lowest to highest).

Source

pub fn merge(&mut self, other: Config)

Merge another configuration into this one.

Values from other override values in self when present.

Source

pub fn create_identity(&self) -> Result<Identity, ConfigError>

Create an Identity from this configuration.

If an nsec is configured, uses that to create the identity. Otherwise, generates a new random identity.

Source

pub fn has_identity(&self) -> bool

Check if an identity is configured (vs. will be generated).

Source

pub fn is_leaf_only(&self) -> bool

Check if leaf-only mode is configured.

Source

pub fn peers(&self) -> &[PeerConfig]

Get the configured peers.

Source

pub fn auto_connect_peers(&self) -> impl Iterator<Item = &PeerConfig>

Get peers that should auto-connect on startup.

Source

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

Validate cross-field configuration invariants.

Source

pub fn to_yaml(&self) -> Result<String, Error>

Serialize this configuration to YAML.

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

Source§

fn default() -> Config

Returns the “default value” for a type. 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 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

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

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