Struct WriteOutcome 

#[non_exhaustive]
pub struct WriteOutcome {
    pub hold: bool,
    pub delay: Option<Duration>,
    pub result: ScriptedResult,
}

One scripted write outcome: an optional hold, an optional delay, then a result.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

hold: bool

Wait for SinkScript::release_held before the delay starts.

delay: Option<Duration>

Sleep this long (tokio time, controllable with test-util) before resolving.

result: ScriptedResult

How the write resolves.

Implementations

impl WriteOutcome

pub fn ok() -> Self

A successful write.

pub fn retryable(reason: impl Into<String>) -> Self

A retryable failure.

pub fn fatal(reason: impl Into<String>) -> Self

A fatal failure.

pub fn after(self, delay: Duration) -> Self

Resolve only after delay of tokio time.

pub fn held(self) -> Self

Keep the write open until the test calls SinkScript::release_held.

No amount of time releases a held write, real or tokio, so a test can assert what the pipeline does while a write is outstanding without reading a clock. A shutdown waits on a held write like any other, so release it before stopping the run.

Trait Implementations

impl Clone for WriteOutcome

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WriteOutcome

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

Formats the value using the given formatter.

impl Eq for WriteOutcome

impl PartialEq for WriteOutcome

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WriteOutcome