Struct PollMessages 

pub struct PollMessages {
    pub consumer: Consumer,
    pub stream_id: Identifier,
    pub topic_id: Identifier,
    pub partition_id: Option<u32>,
    pub strategy: PollingStrategy,
    pub count: u32,
    pub auto_commit: bool,
}

PollMessages command is used to poll messages from a topic in a stream. It has additional payload:

• consumer - consumer which will poll messages. Either regular consumer or consumer group.
• stream_id - unique stream ID (numeric or name).
• topic_id - unique topic ID (numeric or name).
• partition_id - partition ID from which messages will be polled. Has to be specified for the regular consumer. For consumer group it is ignored (use None).
• strategy - polling strategy which specifies from where to start polling messages.
• count - number of messages to poll.
• auto_commit - whether to commit offset on the server automatically after polling the messages.

Fields

consumer: Consumer

Consumer which will poll messages. Either regular consumer or consumer group.

stream_id: Identifier

Unique stream ID (numeric or name).

topic_id: Identifier

Unique topic ID (numeric or name).

partition_id: Option<u32>

Partition ID from which messages will be polled. Has to be specified for the regular consumer. For consumer group it is ignored (use None).

strategy: PollingStrategy

Polling strategy which specifies from where to start polling messages.

count: u32

Number of messages to poll.

auto_commit: bool

Whether to commit offset on the server automatically after polling the messages.

Implementations

impl PollMessages

pub fn bytes( stream_id: &Identifier, topic_id: &Identifier, partition_id: Option<u32>, consumer: &Consumer, strategy: &PollingStrategy, count: u32, auto_commit: bool, ) -> Bytes

pub fn default_number_of_messages_to_poll() -> u32

pub fn default_partition_id() -> Option<u32>

Trait Implementations

impl BytesSerializable for PollMessages

fn to_bytes(&self) -> Bytes

Serializes the struct to bytes.

fn from_bytes(bytes: Bytes) -> Result<PollMessages, IggyError>

Deserializes the struct from bytes.

fn write_to_buffer(&self, _buf: &mut BytesMut)

Write the struct to a buffer.

fn get_buffer_size(&self) -> usize

Get the byte-size of the struct.

impl Command for PollMessages

fn code(&self) -> u32

impl Debug for PollMessages

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

Formats the value using the given formatter.

impl Default for PollMessages

fn default() -> PollMessages

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PollMessages

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PollMessages

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

Formats the value using the given formatter.

impl PartialEq for PollMessages

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validatable<IggyError> for PollMessages

fn validate(&self) -> Result<(), IggyError>

impl StructuralPartialEq for PollMessages