Skip to main content

HookRunContext

Struct HookRunContext 

Source
pub struct HookRunContext<'a> {
    pub dry_run: bool,
    pub log: &'a StageLogger,
    pub template_vars: Option<&'a TemplateVars>,
    pub build_env: Option<&'a HashMap<String, String>>,
    pub extra_env: Option<&'a [(String, String)]>,
}
Expand description

Cross-cutting inputs for run_hooks that stay constant across every hook in a single invocation. Bundled into one struct so call sites read as named fields instead of a run of positional bool / Option arguments. Cheap to pass by value — every field is Copy.

Fields§

§dry_run: bool

Log each hook command instead of executing it.

§log: &'a StageLogger

Sink for status lines and captured command output.

§template_vars: Option<&'a TemplateVars>

When set, hook cmd / dir / env / if are Tera-expanded with these vars before execution, supporting conditionals, filters, and {{ .Env.VAR }}. None runs the literal command with no rendering.

§build_env: Option<&'a HashMap<String, String>>

The active build’s per-target builds[].env map (already rendered/expanded by the build planner). It layers BETWEEN the inherited process env (base) and each hook’s own env: (most specific) — hook env: entries are appended after the build env, so a key present in both resolves to the hook value. None (the default via HookRunContext::new) at non-build hook sites — they have no build env.

§extra_env: Option<&'a [(String, String)]>

Extra environment variables the hook site injects into the hook process (e.g. the ANODIZER_* failure-context vars set by publish on_error hooks). The env channel exists so untrusted values (error bodies, remote stderr) reach hooks WITHOUT being interpolated into the sh -c command string, where shell metacharacters would be command injection. Layered after build_env and before each hook’s own env: entries, so hook env: still wins on key conflicts.

Implementations§

Source§

impl<'a> HookRunContext<'a>

Source

pub fn new( dry_run: bool, log: &'a StageLogger, template_vars: Option<&'a TemplateVars>, ) -> Self

Context for a non-build hook run (the common case): no per-target build_env. Build sites construct the struct directly and set HookRunContext::build_env.

Source

pub fn with_extra_env(self, extra_env: &'a [(String, String)]) -> Self

Attach site-injected env vars (see HookRunContext::extra_env).

Trait Implementations§

Source§

impl<'a> Clone for HookRunContext<'a>

Source§

fn clone(&self) -> HookRunContext<'a>

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 HookRunContext<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for HookRunContext<'a>

§

impl<'a> RefUnwindSafe for HookRunContext<'a>

§

impl<'a> Send for HookRunContext<'a>

§

impl<'a> Sync for HookRunContext<'a>

§

impl<'a> Unpin for HookRunContext<'a>

§

impl<'a> UnsafeUnpin for HookRunContext<'a>

§

impl<'a> UnwindSafe for HookRunContext<'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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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 = 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<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