Struct PipelineExecutionData 

pub struct PipelineExecutionData {
    pub body: PipelineData,
    pub exit: Vec<Option<ExitStatusGuard>>,
    pub early_return: bool,
}

A wrapper to PipelineData which can also track exit status.

We use exit status tracking to implement the pipefail feature.

Fields

body: PipelineData

exit: Vec<Option<ExitStatusGuard>>

early_return: bool

Whether this data was produced by an early return from the block, rather than by evaluating to the end of the block.

The flag exists for a single consumer: top-level file evaluation reads it to detect a top-level return in a script and skip running main. Custom command calls and closure invocations instead clear it via eval_block_with_early_return, so it never leaks past a nested call and only ever reflects a return at the current level.

Implementations

impl PipelineExecutionData

pub fn empty() -> Self

pub fn with_early_return(self) -> Self

Mark this data as having been produced by an early return.

Methods from Deref<Target = PipelineData>

pub fn metadata(&self) -> Option<PipelineMetadata>

👎Deprecated since 0.111.1:

Use .metadata_ref(), .metadata_mut() or .take_metadata() instead

Returns a clone of the metadata if it exists.

Note: This performs a deep clone of heap-allocated structures. Use .metadata_ref(), .metadata_mut() or .take_metadata() to avoid unnecessary allocations.

pub fn metadata_ref(&self) -> Option<&PipelineMetadata>

Returns a reference to the metadata if it exists.

pub fn metadata_mut(&mut self) -> Option<&mut PipelineMetadata>

Returns a mutable reference to the metadata if it exists.

pub fn take_metadata(&mut self) -> Option<PipelineMetadata>

Take the metadata out of pipeline if it exists.

pub fn is_nothing(&self) -> bool

pub fn span(&self) -> Option<Span>

PipelineData doesn’t always have a Span, but we can try!

pub fn get_type(&self) -> Type

Get a type that is representative of the PipelineData.

The type returned here makes no effort to collect a stream, so it may be a different type than would be returned by Value::get_type() on the result of .into_value().

Specifically, a ListStream results in list<any> rather than the fully complete list type (which would require knowing the contents), and a ByteStream with unknown type results in any rather than string or binary.

pub fn clone_exit_status_future(&self) -> Option<ExitStatusGuard>

Trait Implementations

impl Debug for PipelineExecutionData

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

Formats the value using the given formatter.

impl Deref for PipelineExecutionData

type Target = PipelineData

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for PipelineExecutionData

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<PipelineData> for PipelineExecutionData

fn from(value: PipelineData) -> Self

Converts to this type from the input type.