JobRunner

Struct JobRunner 

Source
pub struct JobRunner { /* private fields */ }
Expand description

Runs a specific Job. The simplest way to use this is to repeatedly call run_next_step() until next_step_index() >= step_count().

Implementations§

Source§

impl JobRunner

Source

pub fn container_images(&self) -> &[ContainerImage]

The job requires a specific set of containers, one container per entry in the returned list. Each container must use the given ContainerImage.

Source

pub fn step_count(&self) -> StepIndex

The total number of steps in the job.

Source

pub fn next_step_index(&self) -> StepIndex

The index of the next step to be executed.

Source

pub fn next_step_name(&self) -> Result<Option<String>, RunnerError>

The name of the next step to be executed, if there is one.

Source

pub fn job_name(&self) -> &str

The job name.

Source

pub fn find_step_by_name( &self, step_name: &str, ) -> Result<Option<StepIndex>, RunnerError>

Look up a step by name. We don’t have access to variables set by previous steps so this might not work in obscure cases…

Source

pub fn peek_step_env( &self, step_index: StepIndex, ) -> Result<LinkedHashMap<String, String>, RunnerError>

Get the environment variables set in a specific step. We don’t have access to variables set by previous steps so this might not work in obscure cases…

Source

pub async fn run_next_step<B: RunnerBackend, I>( &mut self, interpose: I, backend: &mut B, ) -> Result<i32, RunnerError>
where I: FnOnce(&mut Vec<String>),

interpose lets you modify the command that will be run for the step.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more