Struct RegistryConfig

pub struct RegistryConfig {
    pub dl: String,
    pub api: Option<String>,
    pub auth_required: bool,
}

The config.json file stored in the index.

The config file may look like:

{
    "dl": "https://example.com/api/{crate}/{version}/download",
    "api": "https://example.com/api",
    "auth-required": false             # unstable feature (RFC 3139)
}

Fields

dl: String

Download endpoint for all crates.

The string is a template which will generate the download URL for the tarball of a specific version of a crate. The substrings {crate} and {version} will be replaced with the crate’s name and version respectively. The substring {prefix} will be replaced with the crate’s prefix directory name, and the substring {lowerprefix} will be replaced with the crate’s prefix directory name converted to lowercase. The substring {sha256-checksum} will be replaced with the crate’s sha256 checksum.

For backwards compatibility, if the string does not contain any markers ({crate}, {version}, {prefix}, or {lowerprefix}), it will be extended with /{crate}/{version}/download to support registries like crates.io which were created before the templating setup was created.

For more on the template of the download URL, see Index Configuration.

api: Option<String>

API endpoint for the registry. This is what’s actually hit to perform operations like yanks, owner modifications, publish new crates, etc. If this is None, the registry does not support API commands.

auth_required: bool

Whether all operations require authentication. See RFC 3139.

Implementations

impl RegistryConfig

const NAME: &'static str = "config.json"

File name of RegistryConfig.

Trait Implementations

impl Clone for RegistryConfig

fn clone(&self) -> RegistryConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegistryConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RegistryConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 56 bytes