Enum RecvOutcome 

pub enum RecvOutcome {
    Batch(ChangeBatch),
    Timeout,
    Closed,
}

Result of a EventWatcher::recv_timeout call.

Variants

Batch(ChangeBatch)

A debounced batch arrived.

Timeout

No batch landed inside the requested timeout. Caller may loop.

Closed

The watcher was dropped or the debounce thread exited; no further batches will arrive on this channel.

Implementations

impl RecvOutcome

pub fn batch(self) -> Option<ChangeBatch>

Returns the wrapped batch, if any.

Examples

use ssg::event_watch::{ChangeBatch, RecvOutcome};
let b = ChangeBatch { paths: vec![] };
let out = RecvOutcome::Batch(b.clone());
assert_eq!(out.batch(), Some(b));
assert!(RecvOutcome::Timeout.batch().is_none());

pub const fn is_closed(&self) -> bool

Returns true if the channel is closed (no more batches).

Examples

use ssg::event_watch::RecvOutcome;
assert!(RecvOutcome::Closed.is_closed());
assert!(!RecvOutcome::Timeout.is_closed());

Trait Implementations

impl Clone for RecvOutcome

fn clone(&self) -> RecvOutcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecvOutcome

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

Formats the value using the given formatter.

impl Eq for RecvOutcome

impl PartialEq for RecvOutcome

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