Struct bytecodec::Eos

pub struct Eos(_);

Eos contains information on the distance to the end of a stream.

Methods

impl Eos

pub fn new(is_eos_reached: bool) -> Self

Makes a new Eos instance.

pub fn with_remaining_bytes(n: ByteCount) -> Self

Makes a new Eos instance that has the given information about the number of remaining bytes in a stream.

pub fn is_reached(&self) -> bool

Returns true if the target stream has reached to the end, otherwise false.

pub fn remaining_bytes(&self) -> ByteCount

Returns the information about the number of bytes remaining in the target stream.

pub fn back(&self, bytes: u64) -> Self

Returns a new Eos instance that has moved backward from the end of the target stream by the specified number of bytes.

Examples

use bytecodec::{ByteCount, Eos};

let eos = Eos::new(true);
assert_eq!(eos.is_reached(), true);
assert_eq!(eos.remaining_bytes(), ByteCount::Finite(0));

let eos = eos.back(5);
assert_eq!(eos.is_reached(), false);
assert_eq!(eos.remaining_bytes(), ByteCount::Finite(5));

Trait Implementations

impl Debug for Eos

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

Formats the value using the given formatter.

impl Clone for Eos

fn clone(&self) -> Eos

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Eos

impl PartialEq for Eos

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

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

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

This method tests for !=.

impl Eq for Eos

impl Hash for Eos

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 PartialOrd for Eos

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

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

fn lt(&self, other: &Eos) -> bool

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

fn le(&self, other: &Eos) -> bool

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

fn gt(&self, other: &Eos) -> bool

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

fn ge(&self, other: &Eos) -> bool

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