Enum LineOutcome 

#[non_exhaustive]
pub enum LineOutcome {
    Sent,
    NoStdin,
    NotWritten {
        reason: String,
    },
}

What happened when the shepherd tried to write one line to a sheep’s stdin.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Sent

The line was written to the pipe and flushed.

Says the bytes left the shepherd, not that the app read them. A pipe holds 64 KiB before it blocks.

NoStdin

The sheep has no stdin pipe: its config does not set stdin = true, or it is not running.

One outcome for two causes: both answer “there is no pipe here”.

NotWritten

The shepherd had a pipe and did not confirm a write to it; carries why.

Three shapes reach it: the write failed (the far end is gone), the line found the sheep’s queue already full, or the write did not finish inside the shepherd’s own bound. The reason names which.

A timed-out write is not a promise the line was never written: the bytes may be part-written into a pipe the app is not draining, and land in full the moment it drains. A line still queued behind that one is dropped once its caller gives up, so treat a retry as a second command.

Fields

reason: String

What went wrong, in plain English.

Trait Implementations

impl Clone for LineOutcome

fn clone(&self) -> LineOutcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LineOutcome

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LineOutcome

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for LineOutcome

impl PartialEq for LineOutcome

fn eq(&self, other: &LineOutcome) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for LineOutcome

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LineOutcome