Skip to main content

RegistryIndex

Struct RegistryIndex 

Source
pub struct RegistryIndex { /* private fields */ }
Expand description

A validated, sparse+-prefix-stripped sparse-index URL: https scheme, no userinfo, and (for a WorkspaceDeclared candidate) a host the live deps_core::net_policy::RegistryAccessPolicy allows.

Validated at construction so an invalid or unsafe URL (http://, a scheme other than sparse+https, a user:pass@ component, or a workspace-declared host the policy blocks) can never reach a network call — this is SSRF-adjacent input, since a workspace file controls a network destination (spec NFR-002, plan-1b §1.1-§1.2).

Implementations§

Source§

impl RegistryIndex

Source

pub fn new( raw: &str, trust: IndexTrust, policy: &RegistryAccessPolicy, ) -> Result<Self, RegistryIndexError>

Validates and wraps raw — a registry-index manifest value, a .cargo/config.toml [registries.<name>].index value, or a [source.<name>] registry value, either optionally prefixed with sparse+.

trust states whose input raw is; for IndexTrust::WorkspaceDeclared, policy’s current deps_core::net_policy::WorkspaceRegistryAccess setting is consulted — a IndexTrust::Trusted candidate is never policy-checked at all, since it is the user’s own $CARGO_HOME configuration, not something a cloned repository controls.

§Errors

Returns RegistryIndexError if raw does not parse as a URL, is not https, carries a userinfo component, or (for a WorkspaceDeclared candidate) resolves to a host class the current policy blocks.

§Examples
use deps_cargo::config::{IndexTrust, RegistryIndex};
use deps_core::net_policy::RegistryAccessPolicy;

let policy = RegistryAccessPolicy::default();
assert!(
    RegistryIndex::new("sparse+https://index.mycorp.dev", IndexTrust::Trusted, &policy)
        .is_ok()
);
assert!(
    RegistryIndex::new("http://index.mycorp.dev", IndexTrust::Trusted, &policy).is_err()
);
assert!(
    RegistryIndex::new(
        "https://user:pass@index.mycorp.dev",
        IndexTrust::Trusted,
        &policy
    )
    .is_err()
);
Source

pub fn as_str(&self) -> &str

The validated URL as a string, with no trailing slash guarantee either way (callers splicing a path onto this must trim as needed — see sparse::sparse_index_url).

Source

pub const fn trust(&self) -> IndexTrust

The IndexTrust tier this index was validated under.

Trait Implementations§

Source§

impl Clone for RegistryIndex

Source§

fn clone(&self) -> RegistryIndex

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RegistryIndex

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for RegistryIndex

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for RegistryIndex

Source§

impl Hash for RegistryIndex

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for RegistryIndex

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for RegistryIndex

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more