pub struct StaticReceiver<T: 'static, R: 'static = DefaultRecycle> { /* private fields */ }
Available on crate features std and static only.
Expand description

Synchronously receives values from associated StaticSenders.

Instances of this struct are created by the StaticChannel::split and ``StaticChannel::try_split` functions.

Implementations

Receives the next message for this receiver, by reference.

This method returns None if the channel has been closed and there are no remaining messages in the channel’s buffer. This indicates that no further values can ever be received from this StaticReceiver. The channel is closed when all StaticSenders have been dropped.

If there are no messages in the channel’s buffer, but the channel has not yet been closed, this method will block until a message is sent or the channel is closed.

This method returns a RecvRef that can be used to read from (or mutate) the received message by reference. When the RecvRef is dropped, the receive operation completes and the slot occupied by the received message becomes usable for a future send_ref operation.

If all StaticSenders for this channel write to the channel’s slots in place by using the send_ref or try_send_ref methods, this method allows messages that own heap allocations to be reused in place.

Examples
use thingbuf::mpsc::blocking::StaticChannel;
use std::{thread, fmt::Write};

static CHANNEL: StaticChannel<String, 100> = StaticChannel::new();
let (tx, rx) = CHANNEL.split();

thread::spawn(move || {
    let mut value = tx.send_ref().unwrap();
    write!(value, "hello world!")
        .expect("writing to a `String` should never fail");
});

assert_eq!(Some("hello world!"), rx.recv_ref().as_deref().map(String::as_str));
assert_eq!(None, rx.recv().as_deref());

Values are buffered:

use thingbuf::mpsc::blocking::StaticChannel;
use std::fmt::Write;

static CHANNEL: StaticChannel<String, 100> = StaticChannel::new();
let (tx, rx) = CHANNEL.split();

write!(tx.send_ref().unwrap(), "hello").unwrap();
write!(tx.send_ref().unwrap(), "world").unwrap();

assert_eq!("hello", rx.recv_ref().unwrap().as_str());
assert_eq!("world", rx.recv_ref().unwrap().as_str());

Receives the next message for this receiver, by value.

This method returns None if the channel has been closed and there are no remaining messages in the channel’s buffer. This indicates that no further values can ever be received from this StaticReceiver. The channel is closed when all StaticSenders have been dropped.

If there are no messages in the channel’s buffer, but the channel has not yet been closed, this method will block until a message is sent or the channel is closed.

When a message is received, it is moved out of the channel by value, and replaced with a new slot according to the configured recycling policy. If all StaticSenders for this channel write to the channel’s slots in place by using the send_ref or try_send_ref methods, consider using the recv_ref method instead, to enable the reuse of heap allocations.

Examples
use thingbuf::mpsc::blocking::StaticChannel;
use std::thread;

static CHANNEL: StaticChannel<i32, 100> = StaticChannel::new();
let (tx, rx) = CHANNEL.split();

thread::spawn(move || {
   tx.send(1).unwrap();
});

assert_eq!(Some(1), rx.recv());
assert_eq!(None, rx.recv());

Values are buffered:

use thingbuf::mpsc::blocking::StaticChannel;

static CHANNEL: StaticChannel<i32, 100> = StaticChannel::new();
let (tx, rx) = CHANNEL.split();

tx.send(1).unwrap();
tx.send(2).unwrap();

assert_eq!(Some(1), rx.recv());
assert_eq!(Some(2), rx.recv());

Attempts to receive the next message for this receiver by reference without blocking.

This method differs from recv_ref by returning immediately if the channel is empty or closed.

Errors

This method returns an error when the channel is closed or there are no remaining messages in the channel’s buffer.

Examples
use thingbuf::mpsc::{blocking, errors::TryRecvError};

let (tx, rx) = blocking::channel(100);
assert!(matches!(rx.try_recv_ref(), Err(TryRecvError::Empty)));

tx.send(1).unwrap();
drop(tx);

assert_eq!(*rx.try_recv_ref().unwrap(), 1);
assert!(matches!(rx.try_recv_ref(), Err(TryRecvError::Closed)));

Attempts to receive the next message for this receiver by value without blocking.

This method differs from recv by returning immediately if the channel is empty or closed.

Errors

This method returns an error when the channel is closed or there are no remaining messages in the channel’s buffer.

Examples
use thingbuf::mpsc::{blocking, errors::TryRecvError};

let (tx, rx) = blocking::channel(100);
assert_eq!(rx.try_recv(), Err(TryRecvError::Empty));

tx.send(1).unwrap();
drop(tx);

assert_eq!(rx.try_recv().unwrap(), 1);
assert_eq!(rx.try_recv(), Err(TryRecvError::Closed));

Returns true if the channel has closed (all corresponding StaticSenders have been dropped).

If this method returns true, no new messages will become available on this channel. Previously sent messages may still be available.

Trait Implementations

Formats the value using the given formatter. Read more
Executes the destructor for this type. Read more
The type of the elements being iterated over.
Advances the iterator and returns the next value. Read more
🔬This is a nightly-only experimental API. (iter_next_chunk)
Advances the iterator and returns an array containing the next N values. Read more
Returns the bounds on the remaining length of the iterator. Read more
Consumes the iterator, counting the number of iterations and returning it. Read more
Consumes the iterator, returning the last element. Read more
🔬This is a nightly-only experimental API. (iter_advance_by)
Advances the iterator by n elements. Read more
Returns the nth element of the iterator. Read more
Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more
Takes two iterators and creates a new iterator over both in sequence. Read more
‘Zips up’ two iterators into a single iterator of pairs. Read more
🔬This is a nightly-only experimental API. (iter_intersperse)
Creates a new iterator which places an item generated by separator between adjacent items of the original iterator. Read more
Takes a closure and creates an iterator which calls that closure on each element. Read more
Calls a closure on each element of an iterator. Read more
Creates an iterator which uses a closure to determine if an element should be yielded. Read more
Creates an iterator that both filters and maps. Read more
Creates an iterator which gives the current iteration count as well as the next value. Read more
Creates an iterator which can use the peek and peek_mut methods to look at the next element of the iterator without consuming it. See their documentation for more information. Read more
Creates an iterator that skips elements based on a predicate. Read more
Creates an iterator that yields elements based on a predicate. Read more
Creates an iterator that both yields elements based on a predicate and maps. Read more
Creates an iterator that skips the first n elements. Read more
Creates an iterator that yields the first n elements, or fewer if the underlying iterator ends sooner. Read more
An iterator adapter similar to fold that holds internal state and produces a new iterator. Read more
Creates an iterator that works like map, but flattens nested structure. Read more
Creates an iterator which ends after the first None. Read more
Does something with each element of an iterator, passing the value on. Read more
Borrows an iterator, rather than consuming it. Read more
Transforms an iterator into a collection. Read more
🔬This is a nightly-only experimental API. (iter_collect_into)
Collects all the items from an iterator into a collection. Read more
Consumes an iterator, creating two collections from it. Read more
🔬This is a nightly-only experimental API. (iter_is_partitioned)
Checks if the elements of this iterator are partitioned according to the given predicate, such that all those that return true precede all those that return false. Read more
An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more
An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more
Folds every element into an accumulator by applying an operation, returning the final result. Read more
Reduces the elements to a single one, by repeatedly applying a reducing operation. Read more
🔬This is a nightly-only experimental API. (iterator_try_reduce)
Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately. Read more
Tests if every element of the iterator matches a predicate. Read more
Tests if any element of the iterator matches a predicate. Read more
Searches for an element of an iterator that satisfies a predicate. Read more
Applies function to the elements of iterator and returns the first non-none result. Read more
🔬This is a nightly-only experimental API. (try_find)
Applies function to the elements of iterator and returns the first true result or the first error. Read more
Searches for an element in an iterator, returning its index. Read more
Returns the element that gives the maximum value from the specified function. Read more
Returns the element that gives the maximum value with respect to the specified comparison function. Read more
Returns the element that gives the minimum value from the specified function. Read more
Returns the element that gives the minimum value with respect to the specified comparison function. Read more
Converts an iterator of pairs into a pair of containers. Read more
Creates an iterator which copies all of its elements. Read more
Creates an iterator which clones all of its elements. Read more
Repeats an iterator endlessly. Read more
🔬This is a nightly-only experimental API. (iter_array_chunks)
Returns an iterator over N elements of the iterator at a time. Read more
Sums the elements of an iterator. Read more
Iterates over the entire iterator, multiplying all the elements Read more
🔬This is a nightly-only experimental API. (iter_order_by)
Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function. Read more
Lexicographically compares the elements of this Iterator with those of another. Read more
🔬This is a nightly-only experimental API. (iter_order_by)
Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function. Read more
Determines if the elements of this Iterator are equal to those of another. Read more
🔬This is a nightly-only experimental API. (iter_order_by)
Determines if the elements of this Iterator are equal to those of another with respect to the specified equality function. Read more
Determines if the elements of this Iterator are unequal to those of another. Read more
Determines if the elements of this Iterator are lexicographically less than those of another. Read more
Determines if the elements of this Iterator are lexicographically less or equal to those of another. Read more
Determines if the elements of this Iterator are lexicographically greater than those of another. Read more
Determines if the elements of this Iterator are lexicographically greater than or equal to those of another. Read more
🔬This is a nightly-only experimental API. (is_sorted)
Checks if the elements of this iterator are sorted using the given comparator function. Read more
🔬This is a nightly-only experimental API. (is_sorted)
Checks if the elements of this iterator are sorted using the given key extraction function. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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