Struct nakadion::consumer::Consumer

pub struct Consumer { /* fields omitted */ }

Consumes an event stream

A consumer can be started to to consume a stream of events. To start it will consume itself and be returned once streaming has stopped so that it can be started again.

A consumer can be stopped internally and externally.

The consumer can be cloned so that that multiple connections to Nakadi can be established. But be aware that in this case the consumers will share their resources, e.g. the API client, metrics and logger.

Methods

impl Consumer

pub fn builder() -> Builder

Get an uninitialized Builder.

pub fn builder_from_env() -> Result<Builder, Error>

Create a Builder initialized with values from the environment whereas the environment variables will be prefixed with NAKADION_.

pub fn builder_from_env_prefixed<T: AsRef<str>>(
    prefix: T
) -> Result<Builder, Error>

Create a Builder initialized with values from the environment whereas the environment variables will be prefixed with <prefix>_.

pub fn start(self) -> (ConsumerHandle, Consuming)

Start consuming events.

A 'Consumingand aConsumerHandlewill be returned. TheConsumingwill complete with aConsumptionOutcomeonce consumption has stopped.Consuming` can be dropped if ther is no interest in waiting the consumer to finish.

The ConsumerHandle can be used to check whether the Consumer is still running and to stop it.

Trait Implementations

impl Clone for Consumer

fn clone(&self) -> Consumer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Consumer

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

Formats the value using the given formatter.