Skip to main content

UReceiver

Struct UReceiver 

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

The receiving side of the unbounded queue.

§Examples

use std::thread;
use std::time::Duration;

use omango::queue::spsc::unbounded;

let (tx, rx) = unbounded();

thread::spawn(move || {
    let _ = tx.send(1);
    thread::sleep(Duration::from_secs(1));
    let _ = tx.send(2);
});

assert_eq!(rx.recv(), Ok(1)); // Received immediately.
assert_eq!(rx.recv(), Ok(2)); // Received after 1 second.

Implementations§

Source§

impl<T: Send> UReceiver<T>

Source

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

Blocks the current thread until a message is received.

When the queue was closed, all receiving waiters will be woken up and return error.

§Examples
use std::thread;
use std::time::Duration;

use omango::queue::spsc::unbounded;
use omango::error::RecvError;

let (tx, rx) = unbounded();

thread::spawn(move || {
    thread::sleep(Duration::from_secs(1));
    tx.send(5).unwrap();
    thread::sleep(Duration::from_secs(1));
    tx.close();
});

assert_eq!(rx.recv(), Ok(5));
assert_eq!(rx.recv(), Err(RecvError));
Source

pub fn close(&self)

Fires closing queue notification.

After closed, all send operations will be failed.

Uses recv to read remaining messages.

§Examples
use std::thread;
use std::time::Duration;

use omango::queue::spsc::unbounded;
use omango::error::{RecvError, SendError};

let (tx, rx) = unbounded();

thread::spawn(move || {
    assert_eq!(tx.send(1), Ok(()));
    tx.close();
});

thread::sleep(Duration::from_millis(500));
assert_eq!(rx.recv(), Ok(1));

Trait Implementations§

Source§

impl<T: Send> Clone for UReceiver<T>

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<T: Send> Send for UReceiver<T>

Source§

impl<T: Send> Sync for UReceiver<T>

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for UReceiver<T>

§

impl<T> !UnwindSafe for UReceiver<T>

§

impl<T> Freeze for UReceiver<T>
where Arc<UnsafeCell<SpscUnbounded<T>>>: Freeze,

§

impl<T> Unpin for UReceiver<T>
where Arc<UnsafeCell<SpscUnbounded<T>>>: Unpin,

§

impl<T> UnsafeUnpin for UReceiver<T>
where Arc<UnsafeCell<SpscUnbounded<T>>>: UnsafeUnpin,

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