Struct Step

pub struct Step<A> { /* private fields */ }

Represents a step in the workflow.

Implementations

impl Step<Run>

pub fn id(self, value: impl Into<String>) -> Step<Run>

Sets the id field of this struct.

pub fn name(self, value: impl Into<String>) -> Step<Run>

Sets the name field of this struct.

pub fn if_condition(self, value: impl Into<Expression>) -> Step<Run>

Sets the if_condition field of this struct.

pub fn with(self, value: impl Into<Input>) -> Step<Run>

Sets the with field of this struct.

pub fn env(self, value: impl Into<Env>) -> Step<Run>

Sets the env field of this struct.

pub fn timeout_minutes(self, value: impl Into<u32>) -> Step<Run>

Sets the timeout_minutes field of this struct.

pub fn continue_on_error(self, value: impl Into<bool>) -> Step<Run>

Sets the continue_on_error field of this struct.

pub fn working_directory(self, value: impl Into<String>) -> Step<Run>

Sets the working_directory field of this struct.

pub fn retry(self, value: impl Into<RetryStrategy>) -> Step<Run>

Sets the retry field of this struct.

pub fn artifacts(self, value: impl Into<Artifacts>) -> Step<Run>

Sets the artifacts field of this struct.

impl Step<Use>

pub fn id(self, value: impl Into<String>) -> Step<Use>

Sets the id field of this struct.

pub fn name(self, value: impl Into<String>) -> Step<Use>

Sets the name field of this struct.

pub fn if_condition(self, value: impl Into<Expression>) -> Step<Use>

Sets the if_condition field of this struct.

pub fn with(self, value: impl Into<Input>) -> Step<Use>

Sets the with field of this struct.

pub fn env(self, value: impl Into<Env>) -> Step<Use>

Sets the env field of this struct.

pub fn timeout_minutes(self, value: impl Into<u32>) -> Step<Use>

Sets the timeout_minutes field of this struct.

pub fn continue_on_error(self, value: impl Into<bool>) -> Step<Use>

Sets the continue_on_error field of this struct.

pub fn working_directory(self, value: impl Into<String>) -> Step<Use>

Sets the working_directory field of this struct.

pub fn retry(self, value: impl Into<RetryStrategy>) -> Step<Use>

Sets the retry field of this struct.

pub fn artifacts(self, value: impl Into<Artifacts>) -> Step<Use>

Sets the artifacts field of this struct.

impl<T> Step<T>

Represents a step in the workflow.

pub fn add_env<R>(self, new_env: R) -> Step<T>

where R: Into<Env>,

Adds an environment variable to the step.

impl Step<Run>

Represents a step that runs a command.

pub fn run<T>(cmd: T) -> Step<Run>

where T: ToString,

Creates a new Step<Run> that runs the provided shell command.

impl Step<Use>

Represents a step that uses an action.

pub fn uses<Owner, Repo, Version>( owner: Owner, repo: Repo, version: Version, ) -> Step<Use>

where Owner: ToString, Repo: ToString, Version: ToString,

Creates a new Step<Use> that uses an action.

pub fn checkout() -> Step<Use>

Creates a step pointing to the default GitHub’s Checkout Action.

pub fn add_with<I>(self, new_with: I) -> Step<Use>

where I: Into<Input>,

Adds a new input to the step.

pub fn add_with_when<I>(self, cond: bool, new_with: I) -> Step<Use>

where I: Into<Input>,

Adds a new input to the step when a condition is met.

Trait Implementations

impl<A> Clone for Step<A>

where A: Clone,

fn clone(&self) -> Step<A>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<A> Debug for Step<A>

where A: Debug,

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

Formats the value using the given formatter.

impl<'de, A> Deserialize<'de> for Step<A>

fn deserialize<__D>( __deserializer: __D, ) -> Result<Step<A>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Cargo> for Step<Run>

fn from(value: Cargo) -> Step<Run>

Converts to this type from the input type.

impl From<Release> for Step<Use>

fn from(value: Release) -> Step<Use>

Converts to this type from the input type.

impl From<Step<Run>> for StepValue

fn from(step: Step<Run>) -> StepValue

Converts a Step<Run> into a StepValue.

impl From<Step<Use>> for StepValue

fn from(step: Step<Use>) -> StepValue

Converts a Step<Use> into a StepValue.

impl From<Toolchain> for Step<Use>

fn from(value: Toolchain) -> Step<Use>

Converts to this type from the input type.

impl<A> PartialEq for Step<A>

where A: PartialEq,

fn eq(&self, other: &Step<A>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<A> Serialize for Step<A>

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<A> Eq for Step<A>

where A: Eq,

impl<A> StructuralPartialEq for Step<A>