Struct Config

pub struct Config {
    pub home_url: Option<String>,
    pub registries_dir: Option<PathBuf>,
    pub content_dir: Option<PathBuf>,
    pub namespace_map_path: Option<PathBuf>,
    pub keys: IndexSet<String>,
    pub keyring_auth: bool,
    pub ignore_federation_hints: bool,
    pub disable_auto_accept_federation_hints: bool,
    pub disable_auto_package_init: bool,
    pub disable_interactive: bool,
    pub keyring_backend: Option<String>,
}

Represents the Warg client configuration.

Fields

home_url: Option<String>

The home Warg registry server URL.

registries_dir: Option<PathBuf>

The path to the top-level directory where per-registry information is stored.

This path is expected to be relative to the configuration file.

If None, the default of $CACHE_DIR/warg/registries is used, where $CACHE_DIR is the platform-specific cache directory.

content_dir: Option<PathBuf>

The path to the directory where package content is stored.

This path is expected to be relative to the configuration file.

If None, the default of $CACHE_DIR/warg/content is used, where $CACHE_DIR is the platform-specific cache directory.

namespace_map_path: Option<PathBuf>

The path to the directory where namespace map is stored.

This path is expected to be relative to the configuration file.

If None, the default of $CACHE_DIR/warg/namespaces is used, where $CACHE_DIR is the platform-specific cache directory.

keys: IndexSet<String>

List of creds available in keyring

keyring_auth: bool

Whether or not an auth key should be retreived from keyring

ignore_federation_hints: bool

Ignore registry hints provided by a warg server

disable_auto_accept_federation_hints: bool

Auto accept registry hint or ask the user to confirm

disable_auto_package_init: bool

Automatically attempt package initialize if does not exist or ask the user to confirm first

disable_interactive: bool

Disable interactive prompts.

keyring_backend: Option<String>

Use the specified backend for keyring access.

Implementations

impl Config

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

Reads the client configuration from the given file path.

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

Writes the client configuration to the given file path.

This function will normalize the paths in the configuration file to be relative to the configuration file’s directory.

pub fn from_default_file() -> Result<Option<Self>>

Loads a client configuration from a default file path.

The following paths are checked in order:

• warg-config.json at the current directory and its parents
• $CONFIG_DIR/warg/config.json

Where $CONFIG_DIR is the platform-specific configuration directory.

Returns Ok(None) if no configuration file was found.

pub fn default_config_path() -> Result<PathBuf>

Gets the path to the default configuration file.

The default configuration file is $CONFIG_DIR/warg/config.json,

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

Gets the path to the directory where per-registry packages are stored.

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

Gets the path to the directory where per-registry packages are stored.

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

Gets the path to the directory where namespace mapping is stored.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

const 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() -> Config

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