Struct Config 

#[non_exhaustive]
pub struct Config {
    pub bep: BepConfig,
    pub schedule: ScheduleConfig,
    pub bandwidth: BandwidthConfig,
    pub parallel: ParallelConfig,
    pub cache: CacheConfig,
    pub advanced: AdvancedConfig,
    pub discovery: DiscoveryConfig,
    pub default_path: Option<PathBuf>,
    pub default_sync_mode: String,
    pub subscribe: SubscribeConfig,
    pub channels: BTreeMap<String, ChannelConfig>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bep: BepConfig

schedule: ScheduleConfig

bandwidth: BandwidthConfig

parallel: ParallelConfig

cache: CacheConfig

advanced: AdvancedConfig

discovery: DiscoveryConfig

default_path: Option<PathBuf>

default_sync_mode: String

subscribe: SubscribeConfig

channels: BTreeMap<String, ChannelConfig>

Named editorial channels backed by iroh-docs catalogs.

Implementations

impl Config

pub fn load(path: impl AsRef<Path>) -> Result<Self>

Errors

Returns an error if the config file cannot be read or parsed.

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

Errors

Returns an error if the config cannot be serialized or written to disk.

pub fn relay_config(&self) -> RelayConfig

pub fn set(&mut self, key: &str, value: &str) -> Result<()>

Errors

Returns an error if the key is unknown or the value cannot be parsed.

pub fn set_subscribe( &mut self, namespace: &str, enabled: bool, filters: &SubscribeFilters, )

Set the live-syncing (subscribe-changes) state and filters for a folder.

The folder’s entry is created on first use, so a plain join writes enabled: false and a later join --subscribe flips it to true without dropping the persisted filters.

pub fn remove_subscribe(&mut self, namespace: &str) -> bool

Remove the per-folder subscribe-changes entry, e.g. when leaving.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Config

impl PartialEq for Config

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Config