Struct Proxy 

pub struct Proxy {
    pub enabled: bool,
    pub num_threads: usize,
    pub download_on_update: bool,
    pub url: Url,
    pub index: Url,
    pub api: Url,
    pub connect_timeout_seconds: u64,
    pub request_timeout_seconds: u64,
    pub user_agent: String,
}

Fields

enabled: bool

Enable crates.io proxy

num_threads: usize

Number of proxy threads

download_on_update: bool

Download crates on index update

url: Url

Crates.io download URL

index: Url

Crates.io index URL

api: Url

Crates.io API URL

connect_timeout_seconds: u64

Connect timeout in seconds for upstream requests

request_timeout_seconds: u64

Request timeout in seconds for upstream downloads

user_agent: String

User-agent sent with requests to crates.io. crates.io’s data-access policy asks for a user-agent that identifies the application and a way to get in contact, e.g. “kellnr.io/kellnr (contact@example.com)”.

Implementations

impl Proxy

pub fn normalize(&mut self)

Lets the upstream URLs end in a slash. They are base URLs for Url::join, which replaces the last path segment if it is missing.

pub fn download_url(&self) -> Result<BaseUrl, BaseUrlError>

Base URL of the crate downloads, proxy.url.

pub fn index_url(&self) -> Result<BaseUrl, BaseUrlError>

Base URL of the sparse index, proxy.index.

pub fn api_url(&self) -> Result<BaseUrl, BaseUrlError>

Base URL of the crates API, proxy.api.

pub fn validate(&self) -> Result<(), String>

Checks the upstream URLs of an enabled proxy, so the accessors of them cannot fail later.

pub fn warnings(&self) -> Vec<String>

Configuration that is accepted but most likely a mistake.

pub fn cratesio_index_override(&self) -> Option<&Url>

The upstream sparse-index URL that internal cargo invocations (e.g. the docs builder) should resolve crates.io dependencies from, if it differs from the built-in crates.io default.

Returns None when the proxy is disabled or the default index is in use. In both cases cargo’s own default (index.crates.io) is correct and source replacement would be redundant. When Some, callers should point cargo’s crates-io source at this URL so dependency resolution honors proxy.index instead of hitting crates.io directly. See #1185.

Trait Implementations

impl Clone for Proxy

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for Proxy

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for Proxy

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

Formats the value using the given formatter.

impl Default for Proxy

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Proxy

where Proxy: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Proxy

impl From<&Proxy> for ProxyPartial

fn from(value: &Proxy) -> Self

Converts to this type from the input type.

impl From<&ProxyProv> for Proxy

fn from(prov: &ProxyProv) -> Self

Converts to this type from the input type.

impl PartialEq for Proxy

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Proxy

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Proxy

impl ToSchema for Proxy

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.