Struct Index 

pub struct Index {
    pub name: Option<IndexName>,
    pub url: IndexUrl,
    pub explicit: bool,
    pub default: bool,
    pub origin: Option<Origin>,
    pub format: IndexFormat,
    pub publish_url: Option<DisplaySafeUrl>,
    pub authenticate: AuthPolicy,
    pub ignore_error_codes: Option<Vec<SerializableStatusCode>>,
    pub cache_control: Option<IndexCacheControl>,
}

Fields

name: Option<IndexName>

The name of the index.

Index names can be used to reference indexes elsewhere in the configuration. For example, you can pin a package to a specific index by name:

[[tool.uv.index]]
name = "pytorch"
url = "https://download.pytorch.org/whl/cu121"

[tool.uv.sources]
torch = { index = "pytorch" }

url: IndexUrl

The URL of the index.

Expects to receive a URL (e.g., https://pypi.org/simple) or a local path.

explicit: bool

Mark the index as explicit.

Explicit indexes will only be used when explicitly requested via a [tool.uv.sources] definition, as in:

[[tool.uv.index]]
name = "pytorch"
url = "https://download.pytorch.org/whl/cu121"
explicit = true

[tool.uv.sources]
torch = { index = "pytorch" }

default: bool

Mark the index as the default index.

By default, uv uses PyPI as the default index, such that even if additional indexes are defined via [[tool.uv.index]], PyPI will still be used as a fallback for packages that aren’t found elsewhere. To disable the PyPI default, set default = true on at least one other index.

Marking an index as default will move it to the front of the list of indexes, such that it is given the highest priority when resolving packages.

origin: Option<Origin>

The origin of the index (e.g., a CLI flag, a user-level configuration file, etc.).

format: IndexFormat

The format used by the index.

Indexes can either be PEP 503-compliant (i.e., a PyPI-style registry implementing the Simple API) or structured as a flat list of distributions (e.g., --find-links). In both cases, indexes can point to either local or remote resources.

publish_url: Option<DisplaySafeUrl>

The URL of the upload endpoint.

When using uv publish --index <name>, this URL is used for publishing.

A configuration for the default index PyPI would look as follows:

[[tool.uv.index]]
name = "pypi"
url = "https://pypi.org/simple"
publish-url = "https://upload.pypi.org/legacy/"

authenticate: AuthPolicy

When uv should use authentication for requests to the index.

[[tool.uv.index]]
name = "my-index"
url = "https://<omitted>/simple"
authenticate = "always"

ignore_error_codes: Option<Vec<SerializableStatusCode>>

Status codes that uv should ignore when deciding whether to continue searching in the next index after a failure.

[[tool.uv.index]]
name = "my-index"
url = "https://<omitted>/simple"
ignore-error-codes = [401, 403]

cache_control: Option<IndexCacheControl>

Cache control configuration for this index.

When set, these headers will override the server’s cache control headers for both package metadata requests and artifact downloads.

[[tool.uv.index]]
name = "my-index"
url = "https://<omitted>/simple"
cache-control = { api = "max-age=600", files = "max-age=3600" }

Implementations

impl Index

pub fn from_index_url(url: IndexUrl) -> Self

Initialize an Index from a pip-style --index-url.

pub fn from_extra_index_url(url: IndexUrl) -> Self

Initialize an Index from a pip-style --extra-index-url.

pub fn from_find_links(url: IndexUrl) -> Self

Initialize an Index from a pip-style --find-links.

pub fn with_origin(self, origin: Origin) -> Self

Set the Origin of the index.

pub fn url(&self) -> &IndexUrl

Return the IndexUrl of the index.

pub fn into_url(self) -> IndexUrl

Consume the Index and return the IndexUrl.

pub fn raw_url(&self) -> &DisplaySafeUrl

Return the raw Url of the index.

pub fn root_url(&self) -> Option<DisplaySafeUrl>

Return the root Url of the index, if applicable.

For indexes with a /simple endpoint, this is simply the URL with the final segment removed. This is useful, e.g., for credential propagation to other endpoints on the index.

pub fn credentials(&self) -> Option<Credentials>

Retrieve the credentials for the index, either from the environment, or from the URL itself.

pub fn relative_to(self, root_dir: &Path) -> Result<Self, IndexUrlError>

Resolve the index relative to the given root directory.

pub fn status_code_strategy(&self) -> IndexStatusCodeStrategy

Return the IndexStatusCodeStrategy for this index.

pub fn artifact_cache_control(&self) -> Option<&str>

Return the cache control header for file requests to this index, if any.

pub fn simple_api_cache_control(&self) -> Option<&str>

Return the cache control header for API requests to this index, if any.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Index

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a Index> for IndexMetadataRef<'a>

fn from(value: &'a Index) -> Self

Converts to this type from the input type.

impl From<Index> for PipExtraIndex

fn from(value: Index) -> Self

Converts to this type from the input type.

impl From<Index> for PipFindLinks

fn from(value: Index) -> Self

Converts to this type from the input type.

impl From<Index> for PipIndex

fn from(value: Index) -> Self

Converts to this type from the input type.

impl From<IndexUrl> for Index

fn from(value: IndexUrl) -> Self

Converts to this type from the input type.

impl From<PipExtraIndex> for Index

fn from(value: PipExtraIndex) -> Self

Converts to this type from the input type.

impl From<PipFindLinks> for Index

fn from(value: PipFindLinks) -> Self

Converts to this type from the input type.

impl From<PipIndex> for Index

fn from(value: PipIndex) -> Self

Converts to this type from the input type.

impl FromStr for Index

type Err = IndexSourceError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Index

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Index

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Index

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Index

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Index

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Index