ThreadSender

Struct ThreadSender 

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

A thread-safe channel sender for intra-process communication.

This is the sending half of a ThreadChannel. It can be cloned to create multiple producers that send to the same channel.

Implementations§

Source§

impl<T> ThreadSender<T>

Source

pub fn send(&self, msg: T) -> Result<()>

Send a message through the channel.

This method blocks if the channel is bounded and full.

§Errors

Returns IpcError::Closed if the channel has been shutdown or all receivers have been dropped.

Source

pub fn try_send(&self, msg: T) -> Result<()>

Try to send a message without blocking.

§Errors
  • IpcError::Closed if the channel has been shutdown or all receivers have been dropped.
  • IpcError::WouldBlock if the channel is full (bounded channels only).
Source

pub fn send_timeout(&self, msg: T, timeout: Duration) -> Result<()>

Send a message with a timeout.

§Errors
  • IpcError::Closed if the channel has been shutdown or all receivers have been dropped.
  • IpcError::Timeout if the timeout expires before the message can be sent.
Source

pub fn is_empty(&self) -> bool

Check if the channel is empty.

Source

pub fn is_full(&self) -> bool

Check if the channel is full (always false for unbounded channels).

Source

pub fn len(&self) -> usize

Get the number of messages in the channel.

Source

pub fn capacity(&self) -> Option<usize>

Get the capacity of the channel (None for unbounded channels).

Source

pub fn is_shutdown(&self) -> bool

Check if the channel has been shutdown.

Source

pub fn shutdown(&self)

Shutdown the channel.

Trait Implementations§

Source§

impl<T> Clone for ThreadSender<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for ThreadSender<T>

Source§

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

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

impl<T> GracefulChannel for ThreadSender<T>

Source§

fn shutdown(&self)

Signal the channel to shutdown Read more
Source§

fn is_shutdown(&self) -> bool

Check if the channel has been signaled to shutdown
Source§

fn drain(&self) -> Result<()>

Wait for all pending messages to be processed Read more
Source§

fn shutdown_timeout(&self, timeout: Duration) -> Result<()>

Shutdown with a timeout Read more

Auto Trait Implementations§

§

impl<T> Freeze for ThreadSender<T>

§

impl<T> RefUnwindSafe for ThreadSender<T>

§

impl<T> Send for ThreadSender<T>
where T: Send,

§

impl<T> Sync for ThreadSender<T>
where T: Send,

§

impl<T> Unpin for ThreadSender<T>

§

impl<T> UnwindSafe for ThreadSender<T>

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

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
§

impl<T> From<T> for T

§

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
§

impl<T, U> Into<U> for T
where U: From<T>,

§

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

Source§

fn metered(self, metrics: Arc<ChannelMetrics>) -> MeteredSender<Self>

Wrap this sender with metrics tracking.
§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

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

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithMetrics for T

Source§

fn with_metrics(self) -> MeteredWrapper<Self>

Wrap this channel with metrics tracking.
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