InstallContext

Struct InstallContext 

Source
pub struct InstallContext<'a> {
Show 13 fields pub project_dir: &'a Path, pub cache: &'a Cache, pub force_refresh: bool, pub verbose: bool, pub manifest: Option<&'a Manifest>, pub lockfile: Option<&'a Arc<LockFile>>, pub old_lockfile: Option<&'a LockFile>, pub project_patches: Option<&'a ManifestPatches>, pub private_patches: Option<&'a ManifestPatches>, pub max_content_file_size: Option<u64>, pub template_context_builder: Arc<TemplateContextBuilder>, pub trust_lockfile_checksums: bool, pub token_warning_threshold: Option<u64>,
}
Expand description

Installation context containing common parameters for resource installation.

This struct bundles frequently-used installation parameters to reduce function parameter counts and improve code readability. It’s used throughout the installation pipeline to pass configuration and context information.

§Fields

  • project_dir - Root directory of the project where resources will be installed
  • cache - Cache instance for managing Git repositories and worktrees
  • force_refresh - Whether to force refresh of cached worktrees
  • manifest - Optional reference to the project manifest for template context
  • lockfile - Optional reference to the lockfile for template context
  • old_lockfile - Optional reference to the previous lockfile for early-exit optimization
  • project_patches - Optional project-level patches from agpm.toml
  • private_patches - Optional user-level patches from agpm.private.toml

Fields§

§project_dir: &'a Path§cache: &'a Cache§force_refresh: bool§verbose: bool§manifest: Option<&'a Manifest>§lockfile: Option<&'a Arc<LockFile>>§old_lockfile: Option<&'a LockFile>§project_patches: Option<&'a ManifestPatches>§private_patches: Option<&'a ManifestPatches>§max_content_file_size: Option<u64>§template_context_builder: Arc<TemplateContextBuilder>

Shared template context builder for all resources

§trust_lockfile_checksums: bool

Trust lockfile checksums without recomputing (ultra-fast path optimization).

When enabled and all inputs match the old lockfile entry, skip file I/O and return the stored checksum. Safe for immutable dependencies (tags/SHAs).

See module-level docs in crate::cli::install for optimization tier details.

§token_warning_threshold: Option<u64>

Token count warning threshold.

When set, resources exceeding this threshold will emit a warning during installation.

Implementations§

Source§

impl<'a> InstallContext<'a>

Source

pub fn builder( project_dir: &'a Path, cache: &'a Cache, ) -> InstallContextBuilder<'a>

Create a new builder for InstallContext.

Source

pub fn with_common_options( project_dir: &'a Path, cache: &'a Cache, manifest: Option<&'a Manifest>, lockfile: Option<&'a Arc<LockFile>>, force_refresh: bool, verbose: bool, old_lockfile: Option<&'a LockFile>, ) -> Self

Create an InstallContext with common options for parallel installation.

This helper function reduces code duplication by handling the common pattern of setting up InstallContext with frequently used options.

§Arguments
  • project_dir - Root directory of the project
  • cache - Cache instance for managing Git repositories
  • manifest - Optional project manifest
  • lockfile - Lockfile for template context
  • force_refresh - Whether to force refresh cached worktrees
  • verbose - Whether to enable verbose output
  • old_lockfile - Optional previous lockfile for early-exit optimization
Source

pub fn with_common_options_and_trust( project_dir: &'a Path, cache: &'a Cache, manifest: Option<&'a Manifest>, lockfile: Option<&'a Arc<LockFile>>, force_refresh: bool, verbose: bool, old_lockfile: Option<&'a LockFile>, trust_lockfile_checksums: bool, token_warning_threshold: Option<u64>, ) -> Self

Create an InstallContext with common options including trust flag.

This is the full version that allows specifying trust_lockfile_checksums and token_warning_threshold.

Auto Trait Implementations§

§

impl<'a> Freeze for InstallContext<'a>

§

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

§

impl<'a> Send for InstallContext<'a>

§

impl<'a> Sync for InstallContext<'a>

§

impl<'a> Unpin for InstallContext<'a>

§

impl<'a> !UnwindSafe for InstallContext<'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> 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: 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: 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, 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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