Skip to main content

EchoClient

Struct EchoClient 

Source
pub struct EchoClient<T, L = Root> { /* private fields */ }
Expand description

Typed client for the echo activation, generated by #[plexus_macros::activation(client)].

Generic over the transport: construct it with any plexus_client::Transport — in-process for tests, WebSocket JSON-RPC or REST + SSE against a server.

A one-item method is an async fn returning Result<item, ClientError>; a many-item method returns a MethodStream. The parameter and item types are the activation’s own, so a change to either is a compile error here, not a runtime surprise.

Implementations§

Source§

impl<T> EchoClient<T>

Source

pub const NAMESPACE: &'static str = "echo"

The activation namespace this client speaks to.

Source

pub fn new(transport: T) -> Self

Wrap a transport.

Source

pub fn at(transport: T, path: impl Into<RoutePath>) -> Self

Wrap a transport, for this activation mounted at path — the dotted route from the service, e.g. "tickets.inputs" for a #[child]. new is at(transport, NAMESPACE). Its events are this activation’s own aggregate; a parent’s child accessor builds one whose events are the parent’s.

Source§

impl<T, L> EchoClient<T, L>

Source

pub fn lifted(transport: T, route: Route, lift: L) -> Self

RETURNS-46: a client on route whose calls’ .events() are lifted by lift — what a parent’s child accessor builds (TreeClient::branch() lifts into TreeEvent).

Source

pub fn path(&self) -> &str

The dotted path this client’s calls go to: the namespace, or the child path it was built at.

Source

pub fn transport(&self) -> &T

Borrow the underlying transport — for reading a MemoryTransport‘s recorded calls, or sharing one transport across several activations’ clients.

Source

pub fn into_transport(self) -> T

Unwrap the transport.

Source§

impl<T: Transport> EchoClient<T>

Source

pub const METHOD_ECHO: MethodRef

Echo a message back the specified number of times

Calls echo.echo.

Source

pub const METHOD_ONCE: MethodRef

Echo a message once

Calls echo.once.

Source§

impl<T: Transport, L: Lift<EchoAggregate>> EchoClient<T, L>

Source

pub fn echo( &self, message: Message, count: u32, ) -> MethodStream<'_, EchoEvent, NoProgress, EchoAggregate, L, __EchoClientEcho>

Echo a message back the specified number of times

Calls echo.echo.

Many items, as a stream of Result<item, ClientError> — a [EchoEchoStream]; progress is dropped unless opted in with .with_progress(), and .events() yields EchoAggregate::Echo — lifted by L into the aggregate of the client this one was reached from (RETURNS-46).

Source

pub fn once( &self, message: Message, ) -> MethodStream<'_, EchoEvent, NoProgress, EchoAggregate, L, __EchoClientOnce>

Echo a message once

Calls echo.once.

Many items, as a stream of Result<item, ClientError> — a [EchoOnceStream]; progress is dropped unless opted in with .with_progress(), and .events() yields EchoAggregate::Once — lifted by L into the aggregate of the client this one was reached from (RETURNS-46).

Trait Implementations§

Source§

impl<T, L> Aggregated for EchoClient<T, L>

Source§

type Event = EchoAggregate

The activation’s own aggregate.
Source§

impl<T: Clone, L: Clone> Clone for EchoClient<T, L>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug, L> Debug for EchoClient<T, L>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Default> Default for EchoClient<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<T> Echo for EchoClient<T>
where T: Transport + Clone + Send + Sync + 'static,

Source§

fn echo(&self, message: Message, count: u32) -> BoxStream<'static, EchoEvent>

Echo a message back the specified number of times
Source§

fn once(&self, message: Message) -> BoxStream<'static, EchoEvent>

Echo a message once

Auto Trait Implementations§

§

impl<T, L> Freeze for EchoClient<T, L>
where T: Freeze, L: Freeze,

§

impl<T, L> RefUnwindSafe for EchoClient<T, L>

§

impl<T, L> Send for EchoClient<T, L>
where T: Send, L: Send,

§

impl<T, L> Sync for EchoClient<T, L>
where T: Sync, L: Sync,

§

impl<T, L> Unpin for EchoClient<T, L>
where T: Unpin, L: Unpin,

§

impl<T, L> UnsafeUnpin for EchoClient<T, L>
where T: UnsafeUnpin, L: UnsafeUnpin,

§

impl<T, L> UnwindSafe for EchoClient<T, L>
where T: UnwindSafe, L: UnwindSafe,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSendSync for T
where T: Send + Sync,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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