Struct StepValue

pub struct StepValue {
    pub id: Option<String>,
    pub name: Option<String>,
    pub if_condition: Option<Expression>,
    pub uses: Option<String>,
    pub with: Option<Input>,
    pub run: Option<String>,
    pub env: Option<Env>,
    pub timeout_minutes: Option<u32>,
    pub continue_on_error: Option<bool>,
    pub working_directory: Option<String>,
    pub retry: Option<RetryStrategy>,
    pub artifacts: Option<Artifacts>,
}

Represents a step value in the workflow.

Fields

id: Option<String>

The ID of the step.

name: Option<String>

The name of the step.

if_condition: Option<Expression>

The condition under which the step runs.

uses: Option<String>

The action to use in the step.

with: Option<Input>

Input parameters for the step.

run: Option<String>

The command to run in the step.

env: Option<Env>

Environment variables for the step.

timeout_minutes: Option<u32>

The timeout for the step in minutes.

continue_on_error: Option<bool>

Whether to continue on error.

working_directory: Option<String>

The working directory for the step.

retry: Option<RetryStrategy>

The retry strategy for the step.

artifacts: Option<Artifacts>

Artifacts produced by the step.

Implementations

impl StepValue

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 StepValue

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

Creates a new StepValue that runs the provided shell command.

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

Creates a new StepValue that uses an action.

Trait Implementations

impl Clone for StepValue

fn clone(&self) -> StepValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StepValue

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

Formats the value using the given formatter.

impl Default for StepValue

fn default() -> StepValue

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StepValue

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 PartialEq for StepValue

fn eq(&self, other: &StepValue) -> 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 Serialize for StepValue

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for StepValue

impl StructuralPartialEq for StepValue