Struct Config

pub struct Config { /* private fields */ }

Wasm Package registry configuration.

Most consumers are expected to start with Config::global_defaults to provide a consistent baseline user experience. Where needed, these defaults can be overridden with application-specific config via Config::merge or other mutation methods.

Implementations

impl Config

pub fn empty() -> Self

Returns an empty config.

Note that this may differ from the Default implementation, which includes hard-coded global defaults.

pub async fn global_defaults() -> Result<Self, Error>

Loads config from several default sources.

The following sources are loaded in this order, with later sources merged into (overriding) earlier sources.

• Hard-coded defaults
• User-global config file (e.g. ~/.config/wasm-pkg/config.toml)

Note: This list is expected to expand in the future to include “workspace” config files like ./.wasm-pkg/config.toml.

pub fn global_config_path() -> Option<PathBuf>

Returns the default global config file location

pub async fn read_global_config() -> Result<Option<Self>, Error>

Reads config from the default global config file location

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

Reads config from a TOML file at the given path.

pub fn from_toml(contents: &str) -> Result<Self, Error>

Parses config from the given TOML contents.

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

Writes the config to a TOML file at the given path.

pub fn merge(&mut self, other: Self)

Merges the given other config into this one.

pub fn resolve_registry(&self, package: &PackageRef) -> Option<&Registry>

Resolves a Registry for the given PackageRef.

Resolution returns the first of these that matches:

• A package registry exactly matching the package
• A namespace registry matching the package’s namespace
• The default registry
• Hard-coded fallbacks for certain well-known namespaces

pub fn default_registry(&self) -> Option<&Registry>

Returns the default registry.

pub fn set_default_registry(&mut self, registry: Option<Registry>)

Sets the default registry.

To unset the default registry, pass None.

pub fn namespace_registry(&self, namespace: &Label) -> Option<&RegistryMapping>

Returns a registry for the given namespace.

Does not fall back to the default registry; see Self::resolve_registry.

pub fn set_namespace_registry( &mut self, namespace: Label, registry: RegistryMapping, )

Sets a registry for the given namespace.

pub fn package_registry_override( &self, package: &PackageRef, ) -> Option<&RegistryMapping>

Returns a registry override configured for the given package.

Does not fall back to namespace or default registries; see Self::resolve_registry.

pub fn set_package_registry_override( &mut self, package: PackageRef, registry: RegistryMapping, )

Sets a registry override for the given package.

pub fn registry_config(&self, registry: &Registry) -> Option<&RegistryConfig>

Returns RegistryConfig for the given registry.

pub fn get_or_insert_registry_config_mut( &mut self, registry: &Registry, ) -> &mut RegistryConfig

Returns a mutable RegistryConfig for the given registry, inserting an empty one if needed.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy 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 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.