Struct IndexLocations 

pub struct IndexLocations { /* private fields */ }

The index locations to use for fetching packages. By default, uses the PyPI index.

This type merges the legacy --index-url, --extra-index-url, and --find-links options, along with the uv-specific --index and --default-index.

Implementations

impl IndexLocations

pub fn new(indexes: Vec<Index>, flat_index: Vec<Index>, no_index: bool) -> Self

Determine the index URLs to use for fetching packages.

pub fn combine( self, indexes: Vec<Index>, flat_index: Vec<Index>, no_index: bool, ) -> Self

Combine a set of index locations.

If either the current or the other index locations have no_index set, the result will have no_index set.

If the current index location has an index set, it will be preserved.

pub fn is_none(&self) -> bool

Returns true if no index configuration is set, i.e., the IndexLocations matches the default configuration.

impl<'a> IndexLocations

pub fn default_index(&'a self) -> Option<&'a Index>

Return the default Index entry.

If --no-index is set, return None.

If no index is provided, use the PyPI index.

pub fn implicit_indexes(&'a self) -> impl Iterator<Item = &'a Index> + 'a

Return an iterator over the implicit Index entries.

Default and explicit indexes are excluded.

pub fn indexes(&'a self) -> impl Iterator<Item = &'a Index> + 'a

Return an iterator over all Index entries in order.

Explicit indexes are excluded.

Prioritizes the extra indexes over the default index.

If no_index was enabled, then this always returns an empty iterator.

pub fn simple_indexes(&'a self) -> impl Iterator<Item = &'a Index> + 'a

Return an iterator over all simple Index entries in order.

If no_index was enabled, then this always returns an empty iterator.

pub fn flat_indexes(&'a self) -> impl Iterator<Item = &'a Index> + 'a

Return an iterator over the [FlatIndexLocation] entries.

pub fn no_index(&self) -> bool

Return the --no-index flag.

pub fn index_urls(&'a self) -> IndexUrls

Clone the index locations into a IndexUrls instance.

pub fn allowed_indexes(&'a self) -> Vec<&'a Index>

Return a vector containing all allowed Index entries.

This includes explicit indexes, implicit indexes, flat indexes, and the default index.

The indexes will be returned in the reverse of the order in which they were defined, such that the last-defined index is the first item in the vector.

pub fn known_indexes(&'a self) -> impl Iterator<Item = &'a Index>

Return a vector containing all known Index entries.

This includes explicit indexes, implicit indexes, flat indexes, and default indexes; in short, it includes all defined indexes, even if they’re overridden by some other index definition.

The indexes will be returned in the reverse of the order in which they were defined, such that the last-defined index is the first item in the vector.

pub fn cache_index_credentials(&self)

Add all authenticated sources to the cache.

pub fn simple_api_cache_control_for(&self, url: &IndexUrl) -> Option<&str>

Return the Simple API cache control header for an IndexUrl, if configured.

pub fn artifact_cache_control_for(&self, url: &IndexUrl) -> Option<&str>

Return the artifact cache control header for an IndexUrl, if configured.

Trait Implementations

impl Clone for IndexLocations

fn clone(&self) -> IndexLocations

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexLocations

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

Formats the value using the given formatter.

impl Default for IndexLocations

fn default() -> IndexLocations

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IndexLocations

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&IndexLocations> for Indexes

fn from(index_locations: &IndexLocations) -> Self

Converts to this type from the input type.

impl PartialEq for IndexLocations

fn eq(&self, other: &IndexLocations) -> 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 Serialize for IndexLocations

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 IndexLocations

impl StructuralPartialEq for IndexLocations