Struct Depth 

#[non_exhaustive]
pub struct Depth {
    pub what: String,
    pub visible: u64,
    pub delayed: u64,
    pub in_flight: u64,
    pub unsent: u64,
    pub approximate: bool,
}

The counts one read_depth found.

Every count is 0 in a feed that holds nothing. A backend whose counts are estimates sets approximate.

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.

what: String

What was read: the queue, topic or list, for logs and errors. Carries no credential.

visible: u64

Units ready to be received.

delayed: u64

Units the feed will make visible later.

in_flight: u64

Units received by a reader and not yet acknowledged or failed.

unsent: u64

Acknowledges and fails this instance handed the backend that the backend has not yet applied.

approximate: bool

Whether the counts are estimates that can lag the feed.

Implementations

impl Depth

pub fn new(what: impl Into<String>, approximate: bool) -> Depth

A reading of what with every count 0. Backends outside this crate build it here and set the counts, as the struct is #[non_exhaustive].

pub fn is_empty(&self) -> bool

Whether every count is 0.

Trait Implementations

impl Clone for Depth

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 Depth

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

Formats the value using the given formatter.

impl Display for Depth

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

Formats the value using the given formatter.

impl Eq for Depth

impl PartialEq for Depth

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Depth