Struct Workflow

pub struct Workflow {
    pub name: Option<String>,
    pub env: Option<Env>,
    pub run_name: Option<String>,
    pub on: Option<Event>,
    pub permissions: Option<Permissions>,
    pub jobs: Option<Jobs>,
    pub concurrency: Option<Concurrency>,
    pub defaults: Option<Defaults>,
    pub secrets: Option<IndexMap<String, Secret>>,
    pub timeout_minutes: Option<u32>,
}

Fields

name: Option<String>

env: Option<Env>

run_name: Option<String>

on: Option<Event>

permissions: Option<Permissions>

jobs: Option<Jobs>

concurrency: Option<Concurrency>

defaults: Option<Defaults>

secrets: Option<IndexMap<String, Secret>>

timeout_minutes: Option<u32>

Implementations

impl Workflow

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

Sets the name field of this struct.

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

Sets the env field of this struct.

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

Sets the run_name field of this struct.

pub fn on(self, value: impl Into<Event>) -> Self

Sets the on field of this struct.

pub fn permissions(self, value: impl Into<Permissions>) -> Self

Sets the permissions field of this struct.

pub fn jobs(self, value: impl Into<Jobs>) -> Self

Sets the jobs field of this struct.

pub fn concurrency(self, value: impl Into<Concurrency>) -> Self

Sets the concurrency field of this struct.

pub fn defaults(self, value: impl Into<Defaults>) -> Self

Sets the defaults field of this struct.

pub fn secrets(self, value: impl Into<IndexMap<String, Secret>>) -> Self

Sets the secrets field of this struct.

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

Sets the timeout_minutes field of this struct.

impl Workflow

pub fn new<T: ToString>(name: T) -> Self

pub fn to_string(&self) -> Result<String, Error>

pub fn add_job<T: ToString, J: Into<Job>>(self, id: T, job: J) -> Self

pub fn parse(yml: &str) -> Result<Self, Error>

pub fn generate(self) -> Result<(), Error>

pub fn add_event<T: Into<Event>>(self, that: T) -> Self

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

Adds the provided value as an environment variable to the workflow.

Trait Implementations

impl Clone for Workflow

fn clone(&self) -> Workflow

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Workflow

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

Formats the value using the given formatter.

impl Default for Workflow

fn default() -> Workflow

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Workflow

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Workflow

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

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 Workflow

impl StructuralPartialEq for Workflow