Struct Sender

pub struct Sender<T: Debug + Send + 'static, C: ChannelSpec> {
    tx: C::Sender<Entry<T>>,
    mq: TypedParticipation<Entry<T>>,
    runtime: DynTimeProvider,
}

Sender for a channel that participates in the memory quota system

Returned by ChannelSpec::new_mq, a method on C. See the module-level docs.

Fields

tx: C::Sender<Entry<T>>

The inner sink

mq: TypedParticipation<Entry<T>>

Our clone of the Participation, for memory accounting

runtime: DynTimeProvider

Time provider for getting the data age

Implementations

impl<T, C> Sender<T, C>

where T: Debug + Send + 'static, C: ChannelSpec,

pub fn time_provider(&self) -> &DynTimeProvider

Obtain a reference to the Sender’s DynTimeProvider

(This can sometimes be used to avoid having to keep a separate clone of the time provider.)

Trait Implementations

impl<T: Debug + Send + 'static, C: ChannelSpec> Clone for Sender<T, C>

where C::Sender<Entry<T>>: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Send + 'static, C: ChannelSpec> Debug for Sender<T, C>

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

Formats the value using the given formatter.

impl<T, C> Sink<T> for Sender<T, C>

where T: HasMemoryCost + Debug + Send + 'static, C: ChannelSpec,

type Error = SendError<<C as ChannelSpec>::SendError>

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: T) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<T, C> SinkCloseChannel<T> for Sender<T, C>

where T: HasMemoryCost + Debug + Send, C: ChannelSpec, C::Sender<Entry<T>>: SinkCloseChannel<Entry<T>>,

fn close_channel(self: Pin<&mut Self>)

Close the channel from the sending end, giving EOF at the receiver

impl<T, C> SinkTrySend<T> for Sender<T, C>

where T: HasMemoryCost + Debug + Send + 'static, C: ChannelSpec, C::Sender<Entry<T>>: SinkTrySend<Entry<T>>, <C::Sender<Entry<T>> as SinkTrySend<Entry<T>>>::Error: Send + Sync,

type Error = ErasedSinkTrySendError

Errors that is not disconnected, or full

fn try_send_or_return( self: Pin<&mut Self>, item: T, ) -> Result<(), (<Self as SinkTrySend<T>>::Error, T)>

Try to send a message msg

fn try_send(self: Pin<&mut Self>, item: T) -> Result<(), Self::Error>

Try to send a message msg