Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub bucket: String,
    pub local: LocalConfig,
    pub indexd: Option<IndexdConfig>,
    pub serve: ServeConfig,
    pub chunking: ChunkingConfig,
    pub credential_store_version: Option<u32>,
}
Expand description

Top-level ObsidianLog configuration, persisted as TOML.

Fields§

§bucket: String

Storage bucket / namespace logs are archived under.

§local: LocalConfig

Local (default) storage backend settings.

§indexd: Option<IndexdConfig>

How to reach the user’s indexd deployment. None (the default) uses the local backend only; set this when archiving to Sia (sia feature).

§serve: ServeConfig

Local HTTP ingest server settings.

§chunking: ChunkingConfig

Chunking / time-window settings.

§credential_store_version: Option<u32>

Which local credential-storage layout this config expects (see the module docs and ADR-0015). None when parsed from a file that predates this field — treated as the legacy, two-item layout. Explicitly #[serde(default)] (defaulting to None) rather than relying on the struct’s blanket default, following the same pattern already used for indexd above, so a missing field always means “legacy” regardless of what Config::default()’s own value is.

Implementations§

Source§

impl Config

Source

pub fn default_path() -> Result<PathBuf>

Resolve the default config path ($XDG_CONFIG_HOME/obsidianlog/config.toml, falling back to ~/.config/obsidianlog/config.toml, using USERPROFILE in place of HOME on Windows when HOME itself isn’t set).

Source

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

Load configuration from path, or the default path when None.

An explicit path must exist. With no path, a missing file at the resolved default location is not an error — Config::default is used instead, so commands work with zero setup against the local backend.

Every command except init must use this function: a config whose credential-storage format doesn’t match CURRENT_CREDENTIAL_VERSION (missing — legacy — or newer than this build understands) fails here, before any keychain access happens. init alone uses Config::load_for_init instead, since offering a route back to a fresh setup is specifically its job (see ADR-0015); no other caller should ever see a legacy config as anything but a hard failure.

Source

pub fn load_for_init(path: Option<&Path>) -> Result<ConfigLoadOutcome>

Load configuration for init’s use only. Unlike Config::load, a missing config file resolves to ConfigLoadOutcome::Missing (whether path was explicit or defaulted — init treats both the same, since either way it means “nothing to reuse yet”) and a legacy config resolves to ConfigLoadOutcome::Legacy rather than erroring, so init can print what continuing would abandon and offer a supported route to a fresh setup. An unrecognized future format still errors here exactly as it does in Config::load — there’s no reasonable repair action for a config written by a newer build.

Source

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

Persist configuration to path, or the default path when None.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Self

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() -> Self

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 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
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 = !

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

fn try_from(value: U) -> Result<T, !>

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> 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