Skip to main content

InstallEnv

Struct InstallEnv 

Source
#[non_exhaustive]
pub struct InstallEnv<'a> { pub fetcher: &'a dyn Fetcher, pub progress: &'a dyn Progress, pub cache_root: &'a Path, pub source_fetcher: Option<&'a dyn SourceFetcher>, pub machine_auth: Option<&'a HashMap<String, AuthCredentials>>, pub autoload_marker: &'a str, pub wording: Wording<'a>, }
Expand description

The runtime seams an install needs, injected so the crate stays free of any HTTP-client / progress-bar / paths policy. Build it with InstallEnv::new plus the with_* methods, and pass it by reference to install_from_lock.

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.
§fetcher: &'a dyn Fetcher

Downloads each dist URL to a verified cache file. Use crate::ReqwestFetcher for the batteries-included default.

§progress: &'a dyn Progress

Per-package progress callbacks. Use crate::NoProgress for silence.

§cache_root: &'a Path

Directory the dist archives are cached under (persistent across runs; created if absent). Composer keeps the equivalent in ~/.composer/cache/files/.

§source_fetcher: Option<&'a dyn SourceFetcher>

Installs packages the lock pins to a git source with no dist. None (the default) makes such packages a preflight error.

§machine_auth: Option<&'a HashMap<String, AuthCredentials>>

Machine-wide credentials from the caller’s own store (a CLI’s login command, say), merged above the global auth.json and below the project’s sources: composer.json config, project auth.json and COMPOSER_AUTH still win.

§autoload_marker: &'a str

File name, under vendor/composer/, of the autoloader freshness marker. Defaults to .composer-install-autoload-fresh.

§wording: Wording<'a>

How warnings and preflight blockers name the calling tool and its commands. Defaults to tool-neutral text; see Wording.

Implementations§

Source§

impl<'a> InstallEnv<'a>

Source

pub fn new( fetcher: &'a dyn Fetcher, progress: &'a dyn Progress, cache_root: &'a Path, ) -> Self

The required seams: a dist fetcher, a progress sink, and the dist cache directory. Source installs are off until with_source_fetcher.

Source

pub fn with_wording(self, wording: Wording<'a>) -> Self

Name the calling tool and its commands in warnings and preflight blockers; see Wording.

Source

pub fn with_machine_auth( self, auth: &'a HashMap<String, AuthCredentials>, ) -> Self

Add machine-wide credentials from the caller’s own store; see machine_auth for the precedence.

Source

pub fn with_autoload_marker(self, name: &'a str) -> Self

Use another file name for the autoloader freshness marker, so a tool that already writes its own keeps its warm state.

Source

pub fn with_source_fetcher(self, source_fetcher: &'a dyn SourceFetcher) -> Self

Install git-source packages with source_fetcher — typically a crate::GitSourceFetcher.

Trait Implementations§

Source§

impl<'a> Clone for InstallEnv<'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<'a> Copy for InstallEnv<'a>

Source§

impl Debug for InstallEnv<'_>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

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

§

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

§

impl<'a> Forget for InstallEnv<'a>

§

impl<'a> Freeze for InstallEnv<'a>

§

impl<'a> Move for InstallEnv<'a>

§

impl<'a> Send for InstallEnv<'a>

§

impl<'a> Sync for InstallEnv<'a>

§

impl<'a> Unpin for InstallEnv<'a>

§

impl<'a> UnsafeUnpin for InstallEnv<'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