Struct Cursor

#[non_exhaustive]
pub struct Cursor {
    pub topic_name: TopicName,
    pub partition_index: i32,
    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
}

Valid versions: 0

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

topic_name: TopicName

The name for the first topic to process

Supported API versions: 0

partition_index: i32

The partition index to start with

Supported API versions: 0

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl Cursor

pub fn with_topic_name(self, value: TopicName) -> Self

Sets topic_name to the passed value.

The name for the first topic to process

Supported API versions: 0

pub fn with_partition_index(self, value: i32) -> Self

Sets partition_index to the passed value.

The partition index to start with

Supported API versions: 0

pub fn with_unknown_tagged_fields(self, value: BTreeMap<i32, Bytes>) -> Self

Sets unknown_tagged_fields to the passed value.

pub fn with_unknown_tagged_field(self, key: i32, value: Bytes) -> Self

Inserts an entry into unknown_tagged_fields.

Trait Implementations

impl Clone for Cursor

fn clone(&self) -> Cursor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cursor

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

Formats the value using the given formatter.

impl Decodable for Cursor

Available on crate feature broker only.

fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self>

Decode the message from the provided buffer and version.

impl Default for Cursor

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for Cursor

Available on crate feature client only.

fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()>

Encode the message into the target buffer.

fn compute_size(&self, version: i16) -> Result<usize>

Compute the total size of the message when encoded.

impl Message for Cursor

const VERSIONS: VersionRange

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for Cursor

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