Struct ConnectedMemoryBroker 

pub struct ConnectedMemoryBroker<Log = Discarding> { /* private fields */ }

The connected form of MemoryBroker: the typed witness that Broker::connect ran.

Cheap to clone: the in-memory bus is shared state by nature, so the connected form is a shareable handle on it, exactly like the unconnected broker. Subscriptions (the Subscribe capability, MemorySource) resolve against this form, and carry over the broker’s log mode: only a Retaining one opens repositionable subscriptions.

Implementations

impl<Log: LogMode> ConnectedMemoryBroker<Log>

pub fn publisher(&self) -> MemoryPublisher

Returns a publisher bound to this broker.

pub fn requester(&self) -> MemoryRequester

Returns a request / reply-capable publisher bound to this broker.

See MemoryBroker::requester for why its operations report RequestError rather than MemoryError.

Trait Implementations

impl<Log> Clone for ConnectedMemoryBroker<Log>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Log: LogMode> ConnectedBroker for ConnectedMemoryBroker<Log>

fn shutdown(self) -> impl Future<Output = Result<Self::Closed, Self::Error>>

Enters the terminal shut-down state: the bus itself flips to its ShutDown variant, so every aliased handle that would touch it (a publisher’s publish or transaction commit, a request) errors with MemoryError::ShutDown. Consuming self makes any further use of this handle a compile error; the returned witness reports how many subscriber registrations the teardown dropped.

type Error = MemoryError

The error type returned by connected-broker operations.

type Closed = ClosedMemoryBroker

The terminal witness returned by shutdown.

impl<Log> Debug for ConnectedMemoryBroker<Log>

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

Formats the value using the given formatter.

impl<Log: LogMode> DefaultPublish for ConnectedMemoryBroker<Log>

type Policy = MemoryPublish

The broker’s plain publish policy, constructible with its defaults.

impl<Log: LogMode> PublishPolicy<ConnectedMemoryBroker<Log>> for MemoryPublish

type Live = MemoryPublisher

The live form this policy pairs into: a Publisher for a leaf policy, or the live wiring form for a combinator stack (a typed publisher over a policy pairs into the same typed publisher over the live leaf).

fn pair( self, connected: &ConnectedMemoryBroker<Log>, ) -> impl Future<Output = Result<Self::Live, PairError>>

Pairs the policy with a connected broker, producing the live publisher.

fn channel_bindings(&self, channel: &str) -> Bindings

What a publish through this policy adds to its channel in the generated AsyncAPI document.

fn operation_bindings(&self, channel: &str) -> Bindings

What a publish through this policy adds to its send operation in the document.

fn message_bindings(&self, channel: &str) -> Bindings

What a publish through this policy adds to the messages that leave through it.

fn reply_address_location(&self) -> Option<&'static str>

Where a client finds the address of a reply this policy publishes, as a runtime expression.

impl<Log: LogMode> PublishPolicy<ConnectedMemoryBroker<Log>> for MemoryRequest

type Live = MemoryRequester

The live form this policy pairs into: a Publisher for a leaf policy, or the live wiring form for a combinator stack (a typed publisher over a policy pairs into the same typed publisher over the live leaf).

fn pair( self, connected: &ConnectedMemoryBroker<Log>, ) -> impl Future<Output = Result<Self::Live, PairError>>

Pairs the policy with a connected broker, producing the live publisher.

fn channel_bindings(&self, channel: &str) -> Bindings

What a publish through this policy adds to its channel in the generated AsyncAPI document.

fn operation_bindings(&self, channel: &str) -> Bindings

What a publish through this policy adds to its send operation in the document.

fn message_bindings(&self, channel: &str) -> Bindings

What a publish through this policy adds to the messages that leave through it.

fn reply_address_location(&self) -> Option<&'static str>

Where a client finds the address of a reply this policy publishes, as a runtime expression.

impl<Log: LogMode> RedeliveryAddressed<ConnectedMemoryBroker<Log>> for MemoryPattern

fn redelivery_address( &self, _connected: &ConnectedMemoryBroker<Log>, ) -> impl Future<Output = Result<RedeliveryAddress, MemoryError>> + Send

The pattern text. A publish to it matches the pattern token for token (* matches the token *, > the token >), so under Routing::EveryMatch it reaches this subscription.

impl<Log: LogMode> RedeliveryAddressed<ConnectedMemoryBroker<Log>> for MemorySource

fn redelivery_address( &self, _connected: &ConnectedMemoryBroker<Log>, ) -> impl Future<Output = Result<RedeliveryAddress, MemoryError>> + Send

Where a publish reaches this subscription again.

impl<Log: LogMode> Subscribe for ConnectedMemoryBroker<Log>

fn subscribe( &self, name: &str, ) -> impl Future<Output = Result<Self::Subscriber, Self::Error>>

A name with a wildcard token is refused with MemoryError::WildcardName: this form reads one name, and MemoryPattern is the one that reads a pattern.

type Subscriber = MemorySubscriber<Log>

The subscriber type opened by a by-name subscription.

type Copies = AddressedCopies

Who publishes the copies a retry of a by-name subscription is made of, and who names where they go. This is what the Name source reports, so it decides how #[subscriber("orders")] retries on this broker.

fn declare_retry( &self, name: &str, declaration: &RetryDeclaration, ) -> Result<(), DeclareRetryError>

Takes what a registration mounted by a bare name declared about its retries, before the subscription opens.

impl<Log: LogMode> SubscriptionSource<ConnectedMemoryBroker<Log>> for MemoryPattern

type Subscriber = MemorySubscriber

The subscriber type this source opens.

type Copies = AddressedCopies

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.

fn subscribe( self, connected: &ConnectedMemoryBroker<Log>, ) -> impl Future<Output = Result<Self::Subscriber, MemoryError>> + Send

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 declare_retry_on( &self, connected: &C, declaration: &RetryDeclaration, ) -> Result<(), DeclareRetryError>

Carries the registration’s declaration to the broker, at the same point and 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.

impl<Log: LogMode> SubscriptionSource<ConnectedMemoryBroker<Log>> for MemorySource

type Subscriber = MemorySubscriber<Log>

The subscriber type this source opens.

type Copies = AddressedCopies

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: &ConnectedMemoryBroker<Log>, ) -> Result<Self::Subscriber, MemoryError>

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 declare_retry_on( &self, connected: &C, declaration: &RetryDeclaration, ) -> Result<(), DeclareRetryError>

Carries the registration’s declaration to the broker, at the same point and 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.

impl<Log: LogMode> TestableBroker for ConnectedMemoryBroker<Log>

Available on crate feature testing only.

fn published(&self, name: &str) -> Vec<RawMessage>

What the broker holds under name: everything published there on a discarding broker (which records for the length of a harness run), and the retained window on a retaining one, so an assertion never claims more than the broker keeps.

fn routes(&self, destination: &str, subscriptions: &[&str]) -> Vec<usize>

The broker’s own rule, read from the Routing it was built with: a name with a wildcard token is a MemoryPattern subscription, every other one an exact name.

fn backlog(&self) -> Backlog

A subscription receives what is published after it opens, on either log mode: a retaining broker keeps its log for a seek to replay, not for a subscription to start from.

fn install_coordinator(&self, coordinator: Coordinator)

Installs the harness coordinator into this broker’s bus for a test run. Idempotent: a second install on the same broker is ignored.

fn inject(&self, message: OutgoingMessage<'_>)

Injects a message onto the bus as an external producer would, synchronously (no awaiting). Routes through the broker’s normal fanout, so it is recorded and counted like any publish.