Struct mz_storage_client::types::sources::MzOffset

pub struct MzOffset {
    pub offset: u64,
}

Universal language for describing message positions in Materialize, in a source independent way. Individual sources like Kafka or File sources should explicitly implement their own offset type that converts to/From MzOffsets. A 0-MzOffset denotes an empty stream.

Fields

offset: u64

Implementations

impl MzOffset

pub fn checked_sub(self, other: Self) -> Option<Self>

Trait Implementations

impl Add<MzOffset> for MzOffset

type Output = MzOffset

The resulting type after applying the + operator.

fn add(self, x: Self) -> Self

Performs the + operation.

impl Add<u64> for MzOffset

type Output = MzOffset

The resulting type after applying the + operator.

fn add(self, x: u64) -> MzOffset

Performs the + operation.

impl AddAssign<MzOffset> for MzOffset

fn add_assign(&mut self, x: Self)

Performs the += operation.

impl AddAssign<u64> for MzOffset

fn add_assign(&mut self, x: u64)

Performs the += operation.

impl Arbitrary for MzOffset

type Parameters = <u64 as Arbitrary>::Parameters

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = Map<<u64 as Arbitrary>::Strategy, fn(_: u64) -> MzOffset>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_top: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for MzOffset

fn clone(&self) -> MzOffset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Codec64 for MzOffset

fn codec_name() -> String

Name of the codec.

fn encode(&self) -> [u8; 8]

Encode a timestamp or diff for permanent storage.

fn decode(buf: [u8; 8]) -> Self

Decode a timestamp or diff previous encoded with this codec’s Codec64::encode.

impl Debug for MzOffset

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

Formats the value using the given formatter.

impl Default for MzOffset

fn default() -> MzOffset

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MzOffset

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MzOffset

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

Formats the value using the given formatter.

impl From<PgLsn> for MzOffset

Convert from PgLsn to MzOffset

fn from(lsn: PgLsn) -> Self

Converts to this type from the input type.

impl From<u64> for MzOffset

Convert from MzOffset to Kafka::Offset as long as the offset is not negative

fn from(offset: u64) -> Self

Converts to this type from the input type.

impl Hash for MzOffset

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 MzOffset

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<MzOffset> for MzOffset

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<MzOffset> for MzOffset

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

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

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

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

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

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

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

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

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 PartialOrder for MzOffset

fn less_equal(&self, other: &Self) -> bool

Returns true iff one element is less than or equal to the other.

fn less_than(&self, other: &Self) -> bool

Returns true iff one element is strictly less than the other.

impl PathSummary<MzOffset> for MzOffset

fn results_in(&self, src: &MzOffset) -> Option<MzOffset>

Advances a timestamp according to the timestamp actions on the path.

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

Composes this path summary with another path summary.

impl Refines<()> for MzOffset

fn to_inner(_: ()) -> Self

Converts the outer timestamp to an inner timestamp.

fn to_outer(self)

Converts the inner timestamp to an outer timestamp.

fn summarize(_: Self::Summary)

Summarizes an inner path summary as an outer path summary.

impl RustType<ProtoMzOffset> for MzOffset

fn into_proto(&self) -> ProtoMzOffset

Convert a Self into a Proto value.

fn from_proto(proto: ProtoMzOffset) -> Result<Self, TryFromProtoError>

Consume and convert a Proto back into a Self value.

impl Semigroup for MzOffset

fn plus_equals(&mut self, rhs: &Self)

The method of std::ops::AddAssign, for types that do not implement AddAssign.

fn is_zero(&self) -> bool

Returns true if the element is the additive identity.

impl Serialize for MzOffset

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

Serialize this value into the given Serde serializer.

impl SourceTimestamp for MzOffset

fn from_compat_ts(pid: PartitionId, offset: MzOffset) -> Self

fn try_into_compat_ts(&self) -> Option<(PartitionId, MzOffset)>

fn from_compat_frontier(frontier: OffsetAntichain) -> Antichain<Self>

fn into_compat_frontier(frontier: AntichainRef<'_, Self>) -> OffsetAntichain

fn encode_row(&self) -> Row

fn decode_row(row: &Row) -> Self

impl Timestamp for MzOffset

type Summary = MzOffset

A type summarizing action on a timestamp along a dataflow path.

fn minimum() -> Self

A minimum value suitable as a default.

impl Copy for MzOffset

impl Eq for MzOffset

impl StructuralEq for MzOffset

impl StructuralPartialEq for MzOffset

impl TotalOrder for MzOffset