Skip to main content

StepInfo

Struct StepInfo 

Source
pub struct StepInfo {
    pub id: StepId,
    pub role: Option<RoleId>,
    pub backend: Option<String>,
    pub produces: Option<ArtifactId>,
    pub typed_inputs: Option<StepInputs>,
}
Expand description

Information about a step needed by action handlers.

This is a subset of Step containing only what handlers need:

  • Step ID (for error messages)
  • Role (for attestation)
  • Backend (for cryptographic operations)
  • Produces (for artifact storage)
  • Typed inputs (pre-resolved artifact references)

Constructed from Step by the executor before calling handlers.

Fields§

§id: StepId

Step identifier (for error messages).

§role: Option<RoleId>

Role that performs this step (for attestation).

§backend: Option<String>

Backend to use for this step (if action requires one).

§produces: Option<ArtifactId>

Artifact ID this step produces (if any).

§typed_inputs: Option<StepInputs>

Pre-resolved input artifact references. Handlers can access artifact IDs directly without parsing ${...} strings.

Implementations§

Source§

impl StepInfo

Source

pub fn new( id: StepId, role: Option<RoleId>, backend: Option<String>, produces: Option<ArtifactId>, typed_inputs: Option<StepInputs>, ) -> Self

Create a new StepInfo from Step fields.

Source

pub fn id_str(&self) -> &str

Get the step ID as a string slice.

Source

pub fn role_str(&self) -> Option<&str>

Get the role as a string reference (for display).

Source

pub fn named_input(&self, key: &str) -> Option<&ArtifactRef>

Look up a named input by key, returning None if missing or if the step uses a single (positional) input.

Source

pub fn required_named_input( &self, key: &str, action: &'static str, ) -> Result<&ArtifactRef, ActionError>

Look up a required named input, returning a uniform ActionError when the input is missing.

§Errors

Returns ActionError::Failed if the input is missing or if the step uses a single (positional) input.

Source

pub fn required_named_inputs( &self, key: &str, action: &'static str, ) -> Result<&[ArtifactRef], ActionError>

Look up a named input that holds a list, in the order written, returning a uniform ActionError when it is missing or holds one reference instead.

§Errors

Returns ActionError::Failed if the input is missing, is not a list, or if the step uses a single (positional) input.

Trait Implementations§

Source§

impl Clone for StepInfo

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 StepInfo

Source§

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

Formats the value using the given formatter. Read more

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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