Struct OffsetOrMin 

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

Event offset within a SourceId’s stream or MIN value

The event offset is not a number, it rather is an identifier that can be compared to other identifiers. There are 2^63 such values. The incr and decr functions find the successor or predecessor, respectively. incr does not return an option because for the use-case of naming events within a stream it is impossible to exhaust the available set of values.

The MIN value is not a valid offset, it is sorted before Offset::ZERO.

Implementations

impl OffsetOrMin

pub const ZERO: OffsetOrMin

Zero offset, equal to Offset::ZERO

pub const MAX: OffsetOrMin

Maximum possible offset

The maximum offset needs to fit into an i64 and also needs to be losslessly converted into an f64 due to interop with languages that do not have proper integers.

See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER

pub const MIN: OffsetOrMin

Minimum value, predecessor of Offset::ZERO

pub fn succ(&self) -> Offset

Return the successor to this offset, where ZERO succeeds MIN

pub fn pred(&self) -> Option<Self>

Return the predecessor to this offset

Trait Implementations

impl Add<u32> for OffsetOrMin

type Output = OffsetOrMin

The resulting type after applying the + operator.

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

Performs the + operation.

impl Bounded for OffsetOrMin

fn min_value() -> Self

Returns the smallest finite number this type can represent

fn max_value() -> Self

Returns the largest finite number this type can represent

impl Clone for OffsetOrMin

fn clone(&self) -> OffsetOrMin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OffsetOrMin

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

Formats the value using the given formatter.

impl Decode<DagCborCodec> for OffsetOrMin

fn decode<R: Read + Seek>(c: DagCborCodec, r: &mut R) -> Result<Self>

Decode from an impl Read.

impl Default for OffsetOrMin

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OffsetOrMin

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OffsetOrMin

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

Formats the value using the given formatter.

impl Encode<DagCborCodec> for OffsetOrMin

fn encode<W: Write>(&self, c: DagCborCodec, w: &mut W) -> Result<()>

Encodes into a impl Write.

impl From<Offset> for OffsetOrMin

fn from(o: Offset) -> Self

Converts to this type from the input type.

impl From<OffsetOrMin> for i64

fn from(original: OffsetOrMin) -> Self

Converts to this type from the input type.

impl From<i64> for OffsetOrMin

fn from(original: i64) -> OffsetOrMin

Converts to this type from the input type.

impl From<u32> for OffsetOrMin

fn from(value: u32) -> Self

Converts to this type from the input type.

impl Hash for OffsetOrMin

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 OffsetOrMin

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

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 PartialEq<OffsetOrMin> for Offset

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

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

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 PartialOrd<OffsetOrMin> for Offset

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

fn partial_cmp(&self, other: &OffsetOrMin) -> 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 OffsetOrMin

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 OffsetOrMin

type Output = i64

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for OffsetOrMin

impl Eq for OffsetOrMin

impl StructuralPartialEq for OffsetOrMin