Skip to main content

OffsetSpec

Enum OffsetSpec 

Source
#[non_exhaustive]
pub enum OffsetSpec { Earliest, Latest, MaxTimestamp, EarliestLocal, LatestTiered, EarliestPendingUpload, Timestamp(i64), }
Expand description

Specifies the desired offsets when using Admin::list_offsets.

Corresponds to org.apache.kafka.clients.admin.OffsetSpec. Java models the variants as nested subclasses of OffsetSpec; the Rust translation uses a single closed enum since the variants carry no behavior beyond their timestamp mapping (getOffsetFromSpec).

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Earliest

Retrieve the earliest offset of a partition.

Mirrors OffsetSpec.EarliestSpec.

§

Latest

Retrieve the latest offset of a partition.

Mirrors OffsetSpec.LatestSpec.

§

MaxTimestamp

Retrieve the offset with the largest timestamp of a partition.

Mirrors OffsetSpec.MaxTimestampSpec.

§

EarliestLocal

Retrieve the local log start offset.

Mirrors OffsetSpec.EarliestLocalSpec.

§

LatestTiered

Retrieve the highest offset of data stored in remote storage.

Mirrors OffsetSpec.LatestTieredSpec.

§

EarliestPendingUpload

Retrieve the earliest offset of records pending upload to remote storage.

Mirrors OffsetSpec.EarliestPendingUploadSpec.

§

Timestamp(i64)

Retrieve the earliest offset whose timestamp is greater than or equal to the given timestamp (in milliseconds).

Mirrors OffsetSpec.TimestampSpec.

Implementations§

Source§

impl OffsetSpec

Source

pub fn latest() -> Self

Used to retrieve the latest offset of a partition.

Mirrors OffsetSpec.latest().

Source

pub fn earliest() -> Self

Used to retrieve the earliest offset of a partition.

Mirrors OffsetSpec.earliest().

Source

pub fn for_timestamp(timestamp: i64) -> Self

Used to retrieve the earliest offset whose timestamp is greater than or equal to the given timestamp (in milliseconds).

Mirrors OffsetSpec.forTimestamp(long).

Source

pub fn max_timestamp() -> Self

Used to retrieve the offset with the largest timestamp of a partition.

Mirrors OffsetSpec.maxTimestamp().

Source

pub fn earliest_local() -> Self

Used to retrieve the local log start offset.

Mirrors OffsetSpec.earliestLocal().

Source

pub fn latest_tiered() -> Self

Used to retrieve the highest offset of data stored in remote storage.

Mirrors OffsetSpec.latestTiered().

Source

pub fn earliest_pending_upload() -> Self

Used to retrieve the earliest offset of records pending upload to remote storage.

Mirrors OffsetSpec.earliestPendingUpload().

Trait Implementations§

Source§

impl Clone for OffsetSpec

Source§

fn clone(&self) -> OffsetSpec

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OffsetSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for OffsetSpec

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for OffsetSpec

Source§

impl Eq for OffsetSpec

Source§

impl StructuralPartialEq for OffsetSpec

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V