Struct Name 

pub struct Name(/* private fields */);

The default SubscriptionSource: subscribe by name string via the Subscribe capability.

Produced by #[subscriber("name")] and usable directly with any connected broker implementing Subscribe.

Examples

use ruststream::{Name, Subscribe, SubscriptionSource};

async fn open<C: Subscribe>(connected: &C) -> Result<C::Subscriber, C::Error> {
    Name::new("orders").subscribe(connected).await
}

Implementations

impl Name

pub fn new(name: impl Into<Cow<'static, str>>) -> Name

Creates a name source bound to name.

Trait Implementations

impl Clone for Name

fn clone(&self) -> Name

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Name

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

Formats the value using the given formatter.

impl FromName for Name

fn from_name(name: impl Into<Cow<'static, str>>) -> Name

Builds the source bound to name.

impl IntoSource for Name

type Source = Name

The source the constructor stores.

fn into_source(self) -> Name

Builds the source.

impl<C> RedeliveryAddressed<C> for Name

where C: Subscribe<Copies = AddressedCopies>,

Where the broker says a subscribe name is also a publish destination, the name is the address, and no lookup stands between the descriptor and the answer.

fn redelivery_address( &self, _connected: &C, ) -> impl Future<Output = Result<RedeliveryAddress, <C as ConnectedBroker>::Error>> + Send

Where a publish reaches this subscription again.

impl<C> SubscriptionSource<C> for Name

where C: Subscribe,

fn declare_retry_on( &self, connected: &C, declaration: &RetryDeclaration, ) -> Result<(), DeclareRetryError>

A name carries no topology of its own, so what the registration declared is the broker’s to take: it answers for the subscription this name opens.

type Subscriber = <C as Subscribe>::Subscriber

The subscriber type this source opens.

type Copies = <C as Subscribe>::Copies

Who publishes the copies this subscription’s retries are made of, and who names where they go: AddressedCopies, NamedCopies or BrokerMoves.

fn name(&self) -> &str

The name (subject / channel) this subscription binds to.

async fn subscribe( self, connected: &C, ) -> Result<<Name as SubscriptionSource<C>>::Subscriber, <C as ConnectedBroker>::Error>

Opens the subscription against the connected broker. Called once at startup.

fn declare_retry(self, declaration: &RetryDeclaration) -> Self

where Self: Sized,

Takes the registration’s retry declaration into the descriptor, before the subscription opens.

fn channel_bindings(&self) -> Bindings

What this subscription adds to its channel in the generated AsyncAPI document.

fn operation_bindings(&self) -> Bindings

What this subscription adds to its receive operation in the document.

fn message_bindings(&self) -> Bindings

What this subscription adds to the messages that arrive on it.