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>) -> Self

Sets the id field of this struct.

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

Sets the name field of this struct.

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

Sets the if_condition field of this struct.

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

Sets the with field of this struct.

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

Sets the env field of this struct.

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

Sets the timeout_minutes field of this struct.

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

Sets the continue_on_error field of this struct.

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

Sets the working_directory field of this struct.

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

Sets the retry field of this struct.

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

Sets the artifacts field of this struct.

impl Step<Use>

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

Sets the id field of this struct.

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

Sets the name field of this struct.

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

Sets the if_condition field of this struct.

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

Sets the with field of this struct.

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

Sets the env field of this struct.

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

Sets the timeout_minutes field of this struct.

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

Sets the continue_on_error field of this struct.

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

Sets the working_directory field of this struct.

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

Sets the retry field of this struct.

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

Sets the artifacts field of this struct.

impl<T> Step<T>

Represents a step in the workflow.

pub fn add_env<R: Into<Env>>(self, new_env: R) -> Self

Adds an environment variable to the step.

impl Step<Run>

Represents a step that runs a command.

pub fn run<T: ToString>(cmd: T) -> Self

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: ToString, Repo: ToString, Version: ToString>( owner: Owner, repo: Repo, version: Version, ) -> Self

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: Into<Input>>(self, new_with: I) -> Self

Adds a new input to the step.

pub fn add_with_when<I: Into<Input>>(self, cond: bool, new_with: I) -> Self

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

Trait Implementations

impl<A: Clone> Clone for Step<A>

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> Debug for Step<A>

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Cargo> for Step<Run>

fn from(value: Cargo) -> Self

Converts to this type from the input type.

impl From<Release> for Step<Use>

fn from(value: Release) -> Self

Converts to this type from the input type.

impl From<Step<Run>> for StepValue

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

Converts a Step<Run> into a StepValue.

impl From<Step<Use>> for StepValue

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

Converts a Step<Use> into a StepValue.

impl From<Toolchain> for Step<Use>

fn from(value: Toolchain) -> Self

Converts to this type from the input type.

impl<A: PartialEq> PartialEq for Step<A>

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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<A: Eq> Eq for Step<A>

impl<A> StructuralPartialEq for Step<A>