Stream

Struct Stream 

Source
pub struct Stream<C: CodecType> { /* private fields */ }
Expand description

A JetStream stream with configurable codec.

§Type Parameters

  • C - The codec type used for message serialization

Implementations§

Source§

impl<C: CodecType> Stream<C>

Source

pub fn inner(&self) -> &Stream

Get the underlying async-nats stream.

Source

pub fn name(&self) -> &str

Get the stream name.

Source

pub async fn info(&self) -> Result<StreamInfo>

Get stream information.

Source

pub fn pull_consumer_builder<T>(&self, name: &str) -> PullConsumerBuilder<T, C>

Create a pull consumer builder.

§Type Parameters
  • T - The message type for this consumer
§Example
use intercom::{Client, MsgPackCodec};
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, Debug)]
struct Event { id: u64 }

let client = Client::<MsgPackCodec>::connect("nats://localhost:4222").await?;
let jetstream = client.jetstream();
let stream = jetstream.get_stream("events").await?;

let consumer = stream
    .pull_consumer_builder::<Event>("my-consumer")
    .durable()
    .filter_subject("events.user.>")
    .create()
    .await?;
Source

pub fn push_consumer_builder<T>(&self, name: &str) -> PushConsumerBuilder<T, C>

Create a push consumer builder.

§Type Parameters
  • T - The message type for this consumer
§Example
use intercom::{Client, MsgPackCodec};
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, Debug)]
struct Event { id: u64 }

let client = Client::<MsgPackCodec>::connect("nats://localhost:4222").await?;
let jetstream = client.jetstream();
let stream = jetstream.get_stream("events").await?;

let consumer = stream
    .push_consumer_builder::<Event>("my-push-consumer")
    .deliver_subject("deliver.events")
    .create()
    .await?;
Source

pub async fn get_pull_consumer<T>( &self, name: &str, ) -> Result<PullConsumer<T, C>>

Get an existing pull consumer by name.

Source

pub async fn get_push_consumer<T>( &self, name: &str, ) -> Result<PushConsumer<T, C>>

Get an existing push consumer by name.

Source

pub async fn delete_consumer(&self, name: &str) -> Result<()>

Delete a consumer by name.

Source

pub async fn purge(&self) -> Result<u64>

Purge all messages from the stream.

Source

pub async fn purge_subject(&self, filter: &str) -> Result<u64>

Purge messages matching a filter subject.

Trait Implementations§

Source§

impl<C: Clone + CodecType> Clone for Stream<C>

Source§

fn clone(&self) -> Stream<C>

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

Auto Trait Implementations§

§

impl<C> Freeze for Stream<C>

§

impl<C> !RefUnwindSafe for Stream<C>

§

impl<C> Send for Stream<C>

§

impl<C> Sync for Stream<C>

§

impl<C> Unpin for Stream<C>
where C: Unpin,

§

impl<C> !UnwindSafe for Stream<C>

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

Source§

type Output = T

Should always be Self
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.
Source§

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

Source§

fn vzip(self) -> V

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