Struct Offset 

pub struct Offset(/* private fields */);

Position of an event within a stream.

Offsets are zero-indexed and sequential. The first event in a stream has offset 0, the second has offset 1, and so on.

Uses u64 internally — offsets are never negative by definition.

Implementations

impl Offset

pub const ZERO: Offset

pub fn new(offset: u64) -> Self

pub fn as_u64(&self) -> u64

Returns the offset as a u64.

pub fn as_usize(&self) -> usize

Returns the offset as a usize for indexing.

Panics

Panics on 32-bit platforms if the offset exceeds usize::MAX.

Trait Implementations

impl Add for Offset

type Output = Offset

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for Offset

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Offset

fn clone(&self) -> Offset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Offset

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

Formats the value using the given formatter.

impl Default for Offset

fn default() -> Offset

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Offset

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Offset

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

Formats the value using the given formatter.

impl From<Offset> for u64

fn from(offset: Offset) -> Self

Converts to this type from the input type.

impl From<u64> for Offset

fn from(value: u64) -> Self

Converts to this type from the input type.

impl Hash for Offset

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Offset

fn cmp(&self, other: &Offset) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Offset

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Offset

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Offset

type Output = Offset

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl Copy for Offset

impl Eq for Offset

impl StructuralPartialEq for Offset