Struct rubble::link::queue::Consume

pub struct Consume<T> {
    should_consume: bool,
    result: Result<T, Error>,
}

Bundles a T along with information telling a queue whether to consume a packet.

Fields

should_consume: bool

result: Result<T, Error>

Implementations

impl<T> Consume<T>

pub fn new(consume: bool, result: Result<T, Error>) -> Self

Consume the currently processed packet iff consume is true, then return result.

pub fn always(result: Result<T, Error>) -> Self

Consume the currently processed packet, then return result.

pub fn never(result: Result<T, Error>) -> Self

Do not consume the currently processed packet, then return result.

The next call to the Consumer::consume_* methods will yield the same packet again.

pub fn on_success(result: Result<T, Error>) -> Self

Consume the currently processed packet if result indicates success, then return the result.

pub fn should_consume(&self) -> bool

Retrieves whether the packet should be removed from the queue.

pub fn result(&self) -> &Result<T, Error>

Retrieves a reference to the inner result.

pub fn into_result(self) -> Result<T, Error>

Unwraps this consume, retrieving the inner result.

Trait Implementations

impl<T: Debug> Debug for Consume<T>

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

Formats the value using the given formatter.