Enum bytecodec::ByteCount

pub enum ByteCount {
    Finite(u64),
    Infinite,
    Unknown,
}

Number of bytes of interest.

Variants

Finite(u64)

Infinite

Unknown

Methods

impl ByteCount

pub fn is_finite(&self) -> bool

Returns true if this is ByteCount::Finite(_), otherwise false.

pub fn is_infinite(&self) -> bool

Returns true if this is ByteCount::Infinite, otherwise false.

pub fn is_unknow(&self) -> bool

Returns true if this is ByteCount::Unknown, otherwise false.

pub fn to_u64(&self) -> Option<u64>

Tries to convert this ByteCount to an u64 value.

If it is not a ByteCount::Finite(_),None will be returned.

pub fn add_for_decoding(self, other: Self) -> Self

Adds two ByteCount instances for decoding (i.e., Decode::requiring_bytes method).

Rule

Finite(a) + Finite(b) = Finite(a + b)
Infinite  + _         = Infinite
_         + Infinite  = Infinite
Unknown   + Unknown   = Unknown
Finite(0) + Unknown   = Unknown
Unknown   + Finite(0) = Unknown
Finite(a) + Unknown   = Finite(a)
Unknown   + Finite(b) = Finite(b)

pub fn add_for_encoding(self, other: Self) -> Self

Adds two ByteCount instances for encoding (i.e., Encode::requiring_bytes method).

Rule

Finite(a) + Finite(b) = Finite(a + b)
Infinite  + _         = Infinite
_         + Infinite  = Infinite
Unknown   + _         = Unknown
_         + Unknown   = Unknown

Trait Implementations

impl Eq for ByteCount

impl Default for ByteCount

fn default() -> Self

Returns ByteCount::Unknown as the default value.

impl Clone for ByteCount

fn clone(&self) -> ByteCount

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<ByteCount> for ByteCount

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<ByteCount> for ByteCount

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Copy for ByteCount

impl Hash for ByteCount

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Debug for ByteCount

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

Formats the value using the given formatter.