timely::communication

Struct Message

Source
pub struct Message<T> { /* private fields */ }
Expand description

A wrapped message which may be either typed or binary data.

Implementations§

Source§

impl<T> Message<T>

Source

pub fn from_typed(typed: T) -> Message<T>

Wrap a typed item as a message.

Source

pub fn from_arc(typed: Arc<T>) -> Message<T>

Wrap a shared typed item as a message.

Source

pub fn if_typed(self) -> Option<T>

Destructures and returns any typed data.

Source

pub fn if_mut(&mut self) -> Option<&mut T>

Returns a mutable reference, if typed.

Source

pub fn as_ref_or_mut(&mut self) -> RefOrMut<'_, T>

Returns an immutable or mutable typed reference.

This method returns a mutable reference if the underlying data are typed Rust instances, which admit mutation, and it returns an immutable reference if the data are serialized binary data.

Source§

impl<T> Message<T>
where T: Data,

Source

pub fn from_bytes(bytes: Bytes) -> Message<T>

Wrap bytes as a message.

Source

pub fn length_in_bytes(&self) -> usize

The number of bytes required to serialize the data.

Source

pub fn into_bytes<W>(&self, writer: &mut W)
where W: Write,

Writes the binary representation into writer.

Source§

impl<T> Message<T>
where T: Clone,

Source

pub fn into_typed(self) -> T

Produces a typed instance of the wrapped element.

Source

pub fn as_mut(&mut self) -> &mut T

Ensures the message is typed data and returns a mutable reference to it.

Trait Implementations§

Source§

impl<T> Deref for Message<T>

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &<Message<T> as Deref>::Target

Dereferences the value.
Source§

impl<T, C: Container, P: Pull<Bundle<T, C>>> Pull<Message<Message<T, C>>> for LogPuller<T, C, P>

Source§

fn pull(&mut self) -> &mut Option<Bundle<T, C>>

Pulls an element and provides the opportunity to take ownership. Read more
Source§

fn recv(&mut self) -> Option<T>

Takes an Option<T> and leaves None behind.
Source§

impl<T> Pull<Message<T>> for Puller<T>
where T: Data,

Source§

fn pull(&mut self) -> &mut Option<Message<T>>

Pulls an element and provides the opportunity to take ownership. Read more
Source§

fn recv(&mut self) -> Option<T>

Takes an Option<T> and leaves None behind.
Source§

impl<T> Pull<Message<T>> for PullerInner<T>
where T: Data,

Source§

fn pull(&mut self) -> &mut Option<Message<T>>

Pulls an element and provides the opportunity to take ownership. Read more
Source§

fn recv(&mut self) -> Option<T>

Takes an Option<T> and leaves None behind.
Source§

impl<T: Timestamp, C: Container, P> Push<Message<Message<T, C>>> for Counter<T, C, P>
where P: Push<Bundle<T, C>>,

Source§

fn push(&mut self, message: &mut Option<Bundle<T, C>>)

Pushes element with the opportunity to take ownership.
Source§

fn send(&mut self, element: T)

Pushes element and drops any resulting resources.
Source§

fn done(&mut self)

Pushes None, conventionally signalling a flush.
Source§

impl<T: Eq + Data, C, P: Push<Bundle<T, C>>, H> Push<Message<Message<T, C>>> for Exchange<T, C, P, H>
where C: PushPartitioned + Container, for<'a> H: FnMut(&C::Item<'a>) -> u64,

Source§

fn push(&mut self, message: &mut Option<Bundle<T, C>>)

Pushes element with the opportunity to take ownership.
Source§

fn send(&mut self, element: T)

Pushes element and drops any resulting resources.
Source§

fn done(&mut self)

Pushes None, conventionally signalling a flush.
Source§

impl<T, C: Container, P: Push<Bundle<T, C>>> Push<Message<Message<T, C>>> for LogPusher<T, C, P>

Source§

fn push(&mut self, pair: &mut Option<Bundle<T, C>>)

Pushes element with the opportunity to take ownership.
Source§

fn send(&mut self, element: T)

Pushes element and drops any resulting resources.
Source§

fn done(&mut self)

Pushes None, conventionally signalling a flush.
Source§

impl<T: Data, C: Container> Push<Message<Message<T, C>>> for Tee<T, C>

Source§

fn push(&mut self, message: &mut Option<Bundle<T, C>>)

Pushes element with the opportunity to take ownership.
Source§

fn send(&mut self, element: T)

Pushes element and drops any resulting resources.
Source§

fn done(&mut self)

Pushes None, conventionally signalling a flush.
Source§

impl<T, P> Push<Message<T>> for Pusher<T, P>
where T: Data, P: BytesPush,

Source§

fn push(&mut self, element: &mut Option<Message<T>>)

Pushes element with the opportunity to take ownership.
Source§

fn send(&mut self, element: T)

Pushes element and drops any resulting resources.
Source§

fn done(&mut self)

Pushes None, conventionally signalling a flush.

Auto Trait Implementations§

§

impl<T> Freeze for Message<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Message<T>
where T: RefUnwindSafe,

§

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

§

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

§

impl<T> Unpin for Message<T>
where T: Unpin,

§

impl<T> UnwindSafe for Message<T>

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.