Skip to main content

FetchSpec

Struct FetchSpec 

Source
#[non_exhaustive]
pub struct FetchSpec<'a> { pub package_name: &'a str, pub url: &'a str, pub sha1: &'a str, pub dest: &'a Path, pub partial_dir: &'a Path, pub auth_header: Option<&'a str>, pub auth_header_name: Option<&'a str>, pub progress: &'a dyn Progress, }
Expand description

One dist to fetch: a single URL plus its verification and auth metadata. The mirror-fallback loop lives in the downloader, which builds a fresh FetchSpec per candidate URL.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§package_name: &'a str

The package the dist belongs to, for progress and error messages. Empty when the fetch is not for a package (a remote patch).

§url: &'a str

The URL to GET. Always http/https — the downloader handles non-HTTP (type: artifact local file) dists itself.

§sha1: &'a str

Expected sha1 hex of the archive (lower-case), or the empty string to skip verification. Composer publishes an empty shasum for VCS-driver zipballs (GitHub/GitLab/Bitbucket), the common case on public Packagist; those are fetched unverified, exactly as Composer does (FileDownloader.php:212).

§dest: &'a Path

Where the verified bytes are placed (atomically). Typically the content-addressed dist cache path.

§partial_dir: &'a Path

Directory for the in-progress temp file. Should ideally sit on the same filesystem as dest so the final rename is intra-filesystem; the default impl also stages a .incoming sibling of dest to guarantee that even when it isn’t.

§auth_header: Option<&'a str>

Pre-rendered Authorization header value (e.g. Basic <b64> or Bearer <tok>), or None for public dists.

§auth_header_name: Option<&'a str>

Header name for the credential. Defaults to authorization when None; set to private-token for GitLab private-token auth.

§progress: &'a dyn Progress

Where to report retries (Progress::on_retry).

Implementations§

Source§

impl<'a> FetchSpec<'a>

Source

pub fn new( url: &'a str, sha1: &'a str, dest: &'a Path, partial_dir: &'a Path, ) -> Self

A spec for url, verified against sha1 (empty skips verification), placed at dest via a temp file in partial_dir. No auth, no package name, and silent progress; set the public fields to change those.

Trait Implementations§

Source§

impl<'a> Clone for FetchSpec<'a>

Source§

fn clone(&self) -> Self

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 FetchSpec<'_>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for FetchSpec<'a>

§

impl<'a> !UnwindSafe for FetchSpec<'a>

§

impl<'a> Forget for FetchSpec<'a>

§

impl<'a> Freeze for FetchSpec<'a>

§

impl<'a> Move for FetchSpec<'a>

§

impl<'a> Send for FetchSpec<'a>

§

impl<'a> Sync for FetchSpec<'a>

§

impl<'a> Unpin for FetchSpec<'a>

§

impl<'a> UnsafeUnpin for FetchSpec<'a>

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

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
Source§

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> Same for T

Source§

type Output = T

Should always be Self
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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