Enum Offset 

pub enum Offset {
    Start,
    Now,
    Concrete {
        read_seq: u64,
        byte_offset: u64,
        raw: [u8; 33],
    },
}

Offset value with validated format.

Canonical format: {read_seq:016x}_{byte_offset:016x}. Sentinels: -1 (stream start), now (tail/live).

Variants

Start

Now

Concrete

Fields

read_seq: u64

byte_offset: u64

raw: [u8; 33]

Implementations

impl Offset

pub const START: &'static str = "-1"

Sentinel value for stream start

pub const NOW: &'static str = "now"

Sentinel value for stream tail/live mode

pub fn new(read_seq: u64, byte_offset: u64) -> Self

Create a new offset from read sequence and byte offset.

pub fn start() -> Self

Create the stream start sentinel

pub fn now() -> Self

Create the tail/now sentinel

pub fn is_start(&self) -> bool

Check if this is the start sentinel

pub fn is_now(&self) -> bool

Check if this is the now/tail sentinel

pub fn is_sentinel(&self) -> bool

Check if this is a sentinel value (start or now)

pub fn as_str(&self) -> &str

Get the canonical offset string.

pub fn parse_components(&self) -> Option<(u64, u64)>

Parse the offset into (read_seq, byte_offset) components.

Returns None for sentinel values.

Trait Implementations

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 Display for Offset

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

Formats the value using the given formatter.

impl From<Offset> for String

fn from(offset: Offset) -> Self

Converts to this type from the input type.

impl FromStr for Offset

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this 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: &Self) -> 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: &Self) -> 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: &Self) -> 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 Eq for Offset