Skip to main content

Outgoing

Struct Outgoing 

Source
pub struct Outgoing<'a> { /* private fields */ }
Expand description

A mutable outgoing message flowing through the publish pipeline.

The name is an OutgoingName, which carries a destination from any of the three places one comes from without copying it: the macro reply path borrows a string literal (reply_name(&self) -> &str), a computed name moves in owned, and a name read off the delivery being answered arrives as the delivery’s own buffer. The payload behaves the same way: codec output moves in whole, a rebuilt message carries the buffer it was handed or lends the bytes it was lent, and the first payload_mut or set_payload is what makes the buffer this message’s own. Middleware may change the name, transform the payload, and enrich the headers before the message is sent.

Implementations§

Source§

impl<'a> Outgoing<'a>

Source

pub fn new( name: impl Into<OutgoingName<'a>>, payload: impl Into<BytesMut>, ) -> Self

Creates an outgoing message with no headers.

Pass a &str (a borrowed destination, the no-allocation case), a String (a computed owned one) or a Str (a buffer something else already holds) for name; pass a BytesMut (codec output moves in) or a &[u8] for the payload.

Source

pub fn name(&self) -> &str

The destination name.

Source

pub fn set_name(&mut self, name: impl Into<OutgoingName<'a>>)

Sets the destination name.

A literal or a borrow costs nothing, a computed String moves in, and a Str read off the delivery shares its buffer rather than copying out of it.

§Examples
use ruststream::{Bytes, Str};
use ruststream::runtime::Outgoing;

let mut out = Outgoing::new("answers", b"{}".as_slice());
out.set_name("replies.inbox");
assert_eq!(out.name(), "replies.inbox");

// The same setter takes the buffer a delivery arrived in, with no copy between them.
out.set_name(Str::try_from(Bytes::from_static(b"replies.7"))?);
assert_eq!(out.name(), "replies.7");
Source

pub fn payload(&self) -> &[u8] ⓘ

The payload bytes.

Source

pub fn payload_mut(&mut self) -> &mut BytesMut

The payload bytes, mutably (for envelope wrapping).

A message that is still lending the bytes it was built from copies them here, once.

Source

pub fn set_payload(&mut self, payload: impl Into<BytesMut>)

Replaces the payload.

Source

pub fn headers(&self) -> &HeaderMap

The outgoing headers.

Source

pub fn headers_mut(&mut self) -> &mut HeaderMap

The outgoing headers, mutably.

Trait Implementations§

Source§

impl<'a> Clone for Outgoing<'a>

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<'a> Debug for Outgoing<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> !Freeze for Outgoing<'a>

§

impl<'a> RefUnwindSafe for Outgoing<'a>

§

impl<'a> Send for Outgoing<'a>

§

impl<'a> Sync for Outgoing<'a>

§

impl<'a> Unpin for Outgoing<'a>

§

impl<'a> UnsafeUnpin for Outgoing<'a>

§

impl<'a> UnwindSafe for Outgoing<'a>

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

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> PublishedThrough<DefaultSlot> for T

Source§

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

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