pub struct StreamPartitionQueue<C, R = DefaultRuntime>
where C: ConsumerContext + 'static,
{ /* private fields */ }
Expand description

A message queue for a single partition of a StreamConsumer.

See the documentation of StreamConsumer::split_partition_queue for details.

Implementations§

source§

impl<C, R> StreamPartitionQueue<C, R>
where C: ConsumerContext,

source

pub fn stream(&self) -> MessageStream<'_>

Constructs a stream that yields messages from this partition.

It is legal to have multiple live message streams for the same partition, and to move those message streams across threads. Note, however, that the message streams share the same underlying state. A message received by the partition will be delivered to only one of the live message streams. If you seek the underlying partition, all message streams created from the partition will begin to draw messages from the new position of the partition.

If you want multiple independent views of a Kafka partition, create multiple consumers, not multiple partition streams.

source

pub async fn recv(&self) -> Result<BorrowedMessage<'_>, KafkaError>

Receives the next message from the stream.

This method will block until the next message is available or an error occurs. It is legal to call recv from multiple threads simultaneously.

This method is cancellation safe.

Note that this method is exactly as efficient as constructing a single-use message stream and extracting one message from it:

use futures::stream::StreamExt;
partition_queue.stream().next().await.expect("MessageStream never returns None");

Trait Implementations§

source§

impl<C, R> Drop for StreamPartitionQueue<C, R>
where C: ConsumerContext,

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<C, R> Freeze for StreamPartitionQueue<C, R>

§

impl<C, R = TokioRuntime> !RefUnwindSafe for StreamPartitionQueue<C, R>

§

impl<C, R> Send for StreamPartitionQueue<C, R>
where R: Sync + Send,

§

impl<C, R> Sync for StreamPartitionQueue<C, R>
where R: Sync + Send,

§

impl<C, R> Unpin for StreamPartitionQueue<C, R>

§

impl<C, R = TokioRuntime> !UnwindSafe for StreamPartitionQueue<C, R>

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more