Struct nakadi_types::partition::Partition

pub struct Partition {
    pub partition: PartitionId,
    pub oldest_available_offset: CursorOffset,
    pub newest_available_offset: CursorOffset,
    pub unconsumed_events: Option<u64>,
}

Partition information. Can be helpful when trying to start a stream using an unmanaged API.

This information is not related to the state of the consumer clients.

See also Nakadi Manual

Fields

partition: PartitionId

oldest_available_offset: CursorOffset

An offset of the oldest available Event in that partition. This value will be changing upon removal of Events from the partition by the background archiving/cleanup mechanism.

newest_available_offset: CursorOffset

An offset of the newest available Event in that partition. This value will be changing upon reception of new events for this partition by Nakadi.

This value can be used to construct a cursor when opening streams (see GET /event-type/{name}/events for details).

Might assume the special name BEGIN, meaning a pointer to the offset of the oldest available event in the partition.

unconsumed_events: Option<u64>

Approximate number of events unconsumed by the client. This is also known as consumer lag and is used for monitoring purposes by consumers interested in keeping an eye on the number of unconsumed events.

If the event type uses ‘compact’ cleanup policy - then the actual number of unconsumed events in this partition can be lower than the one reported in this field.

Implementations

impl Partition

pub fn into_partition_id(self) -> PartitionId

Trait Implementations

impl Clone for Partition

fn clone(&self) -> Partition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Partition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Partition

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

Deserialize this value from the given Serde deserializer.

impl From<Partition> for PartitionId

fn from(p: Partition) -> Self

Performs the conversion.

impl Serialize for Partition

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

Serialize this value into the given Serde serializer.