Struct barrage::SharedReceiver

source · [−]

pub struct SharedReceiver<T: Clone + Unpin>(_);

Expand description

A shared receiver is similar to a receiver, but it shares a mailbox with the other shared receivers from which it originates (was cloned from). Thus, only one shared receiver with the same mailbox will receive a broadcast.

Implementations

source

impl<T: Clone + Unpin> SharedReceiver<T>

source

pub fn upgrade(self) -> Receiver<T>

Upgrades this shared receiver into a full receiver with its own mailbox

source

pub fn same_mailbox(&self, other: &SharedReceiver<T>) -> bool

Checks whether this shared receiver shares a mailbox with another.

source

pub fn recv(&self) -> Result<T, Disconnected>

Receive a broadcast message. If there are none in the queue, it will block until another is sent or all senders disconnect.

source

pub fn try_recv(&self) -> Result<Option<T>, Disconnected>

Try to receive a broadcast message. If there are none in the queue, it will return None, or if there are no senders it will return Disconnected.

source

pub fn recv_async(&self) -> RecvFut<'_, T>ⓘNotable traits for RecvFut<'a, T>`impl<'a, T: Clone + Unpin> Future for RecvFut<'a, T> type Output = Result<T, Disconnected>;`

Receive a broadcast message. If there are none in the queue, it will asynchronously wait until another is sent or all senders disconnect.

Trait Implementations

source

impl<T: Clone + Unpin> Clone for SharedReceiver<T>

source

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

Auto Trait Implementations

impl<T> !RefUnwindSafe for SharedReceiver<T>

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

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

impl<T> Unpin for SharedReceiver<T>

impl<T> !UnwindSafe for SharedReceiver<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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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> ToOwned for T where
T: Clone,

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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct barrage::SharedReceiver

Implementations

impl<T: Clone + Unpin> SharedReceiver<T>

pub fn upgrade(self) -> Receiver<T>

pub fn same_mailbox(&self, other: &SharedReceiver<T>) -> bool

pub fn recv(&self) -> Result<T, Disconnected>

pub fn try_recv(&self) -> Result<Option<T>, Disconnected>

pub fn recv_async(&self) -> RecvFut<'_, T>ⓘNotable traits for RecvFut<'a, T>`impl<'a, T: Clone + Unpin> Future for RecvFut<'a, T> type Output = Result<T, Disconnected>;`

Trait Implementations

impl<T: Clone + Unpin> Clone for SharedReceiver<T>

fn clone(&self) -> Self

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

Auto Trait Implementations

impl<T> !RefUnwindSafe for SharedReceiver<T>

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

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

impl<T> Unpin for SharedReceiver<T>

impl<T> !UnwindSafe for SharedReceiver<T>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

Struct barrage::SharedReceiver

Implementations

impl<T: Clone + Unpin> SharedReceiver<T>

pub fn upgrade(self) -> Receiver<T>

pub fn same_mailbox(&self, other: &SharedReceiver<T>) -> bool

pub fn recv(&self) -> Result<T, Disconnected>

pub fn try_recv(&self) -> Result<Option<T>, Disconnected>

pub fn recv_async(&self) -> RecvFut<'_, T>ⓘNotable traits for RecvFut<'a, T>impl<'a, T: Clone + Unpin> Future for RecvFut<'a, T> type Output = Result<T, Disconnected>;

Trait Implementations

impl<T: Clone + Unpin> Clone for SharedReceiver<T>

fn clone(&self) -> Self

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

Auto Trait Implementations

impl<T> !RefUnwindSafe for SharedReceiver<T>

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

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

impl<T> Unpin for SharedReceiver<T>

impl<T> !UnwindSafe for SharedReceiver<T>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

pub fn recv_async(&self) -> RecvFut<'_, T>ⓘNotable traits for RecvFut<'a, T>`impl<'a, T: Clone + Unpin> Future for RecvFut<'a, T> type Output = Result<T, Disconnected>;`

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

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

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

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

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

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

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

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

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