Skip to main content

Config

Struct Config 

Source
#[non_exhaustive]
pub struct Config { pub download: DownloadConfig, pub network: NetworkConfig, pub hub: HubConfig, pub bt: BtConfig, pub state_dir: Option<PathBuf>, pub headers: BTreeMap<String, String>, }
Expand description

Effective configuration. Precedence is CLI flags > config file > environment variables > built-in defaults; see Config::load.

Fields (Non-exhaustive)§

This struct is marked as 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.
§download: DownloadConfig

Download behavior and defaults.

§network: NetworkConfig

HTTP timeout, retry and user-agent settings.

§hub: HubConfig

Hub provider cache and endpoint settings.

§bt: BtConfig

BitTorrent backend settings.

§state_dir: Option<PathBuf>

Directory for task sidecars; defaults to the platform data directory.

§headers: BTreeMap<String, String>

Default headers applied to every request; values may use ${env:NAME} placeholders.

Implementations§

Source§

impl Config

Source

pub fn default_config_path() -> Result<PathBuf>

Platform default config file path (config.toml in the user config directory).

Source

pub fn default_state_dir() -> Result<PathBuf>

Platform default directory for task sidecars.

Source

pub fn state_dir(&self) -> Result<PathBuf>

Configured state directory, or the platform default.

Source

pub fn hf_cache_dir(&self) -> Result<PathBuf>

Resolved Hugging Face cache root: configured override or ~/.cache/huggingface/hub.

Source

pub fn modelscope_cache_dir(&self) -> Result<PathBuf>

Resolved ModelScope cache root: configured override or the platform cache directory.

Source

pub fn content_cache_dir(&self) -> Result<PathBuf>

Resolved content-addressed cache root: configured override or the platform cache directory under shaul/content.

Source

pub fn hf_endpoint(&self) -> String

Configured Hugging Face endpoint or the public default.

Source

pub fn modelscope_endpoint(&self) -> String

Configured ModelScope endpoint or the public default.

Source

pub fn resolve_path(explicit: Option<&Path>) -> Result<PathBuf>

Resolve the config path from an explicit argument, SHAUL_CONFIG, or the platform default.

Source

pub fn load(explicit: Option<&Path>) -> Result<(Self, PathBuf)>

Load defaults, then environment variables, then the config file. CLI flags are applied by the caller afterwards.

Source

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

Load only defaults + file. Used by config set so environment values are not baked into the file.

Source

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

Serialize the config as TOML, creating parent directories as needed.

Source

pub fn apply_env(&mut self) -> Result<()>

Apply SHAUL_* and provider environment variables on top of the current values.

Source

pub fn header_defaults(&self) -> Result<Vec<Header>>

Parse the configured default headers into validated Header values.

Source

pub fn resolve( &self, destination: &Path, options: &TaskOptions, ) -> Result<ResolvedOptions>

Combine config defaults with per-task options into fully resolved settings.

Source

pub fn get_value(&self, key: &str) -> Result<String>

Read a config value by its dotted key, as used by config get.

Source

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

Set a config value by its dotted key, as used by config set.

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§

§

impl Forget for Config

§

impl Freeze for Config

§

impl Move for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnsafeUnpin for Config

§

impl UnwindSafe for Config

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