Struct Config 

pub struct Config {

    pub default_profile: String,
    pub profile: HashMap<String, Profile>,
    pub repositories: Vec<Repository>,
    pub cache_path: Option<String>,
    pub db_path: Option<String>,
    pub bin_path: Option<String>,
    pub repositories_path: Option<String>,
    pub portable_dirs: Option<String>,
    pub parallel: Option<bool>,
    pub parallel_limit: Option<u32>,
    pub ghcr_concurrency: Option<u64>,
    pub search_limit: Option<usize>,
    pub cross_repo_updates: Option<bool>,
    pub install_patterns: Option<Vec<String>>,
    pub signature_verification: Option<bool>,
    pub desktop_integration: Option<bool>,
    pub sync_interval: Option<String>,
    pub nests_sync_interval: Option<String>,
}

Application’s configuration

Fields

default_profile: String

The name of the default profile to use.

profile: HashMap<String, Profile>

A map of profile names to their configurations.

repositories: Vec<Repository>

List of configured repositories.

cache_path: Option<String>

Path to the local cache directory. Default: $SOAR_ROOT/cache

db_path: Option<String>

Path where the Soar package database is stored. Default: $SOAR_ROOT/db

bin_path: Option<String>

Directory where binary symlinks are placed. Default: $SOAR_ROOT/bin

repositories_path: Option<String>

Path to the local clone of all repositories. Default: $SOAR_ROOT/packages

portable_dirs: Option<String>

Portable dirs path Default: $SOAR_ROOT/portable-dirs

parallel: Option<bool>

If true, enables parallel downloading of packages. Default: true

parallel_limit: Option<u32>

Maximum number of parallel downloads. Default: 4

ghcr_concurrency: Option<u64>

Maximum number of concurrent requests for GHCR (GitHub Container Registry). Default: 8

search_limit: Option<usize>

Limits the number of results returned by a search. Default: 20

cross_repo_updates: Option<bool>

Allows packages to be updated across different repositories. NOTE: This is not yet implemented

install_patterns: Option<Vec<String>>

Glob patterns for package files that should be included during install. Default: [“!.log”, “!SBUILD”, “!.json”, “!*.version”]

signature_verification: Option<bool>

Global override for signature verification

desktop_integration: Option<bool>

Global override for desktop integration

sync_interval: Option<String>

Global override for sync interval

nests_sync_interval: Option<String>

Sync interval for nests

Implementations

impl Config

pub fn default_config<T: AsRef<str>>( external: bool, selected_repos: &[T], ) -> Self

pub fn new() -> Result<Self, ConfigError>

Creates a new configuration by loading it from the configuration file. If the configuration file is not found, it uses the default configuration.

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

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

pub fn get_profile(&self, name: &str) -> Result<&Profile, ConfigError>

pub fn get_bin_path(&self) -> SoarResult<PathBuf>

pub fn get_db_path(&self) -> SoarResult<PathBuf>

pub fn get_packages_path( &self, profile_name: Option<String>, ) -> SoarResult<PathBuf>

pub fn get_cache_path(&self) -> SoarResult<PathBuf>

pub fn get_repositories_path(&self) -> SoarResult<PathBuf>

pub fn get_portable_dirs(&self) -> SoarResult<PathBuf>

pub fn get_nests_db_conn(&self) -> SoarResult<Connection>

pub fn get_nests_sync_interval(&self) -> u128

pub fn get_repository(&self, repo_name: &str) -> Option<&Repository>

pub fn has_desktop_integration(&self, repo_name: &str) -> bool

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

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

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

const DOCS: &'static str = "Application\'s configuration"

The static doc comments on this type.

impl DocumentedFields for Config

const FIELD_NAMES: &'static [&'static str]

Field names, as accepted by Self::get_field_docs.

const FIELD_DOCS: &'static [&'static str]

The static doc comments on each field or variant of this type, indexed by field/variant order.

fn get_field_docs<T>(field_name: T) -> Result<&'static str, Error>

where T: AsRef<str>,

Get a field’s documentation using its name.

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.