devela 0.27.0

A development layer of coherence.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

// devela::sys::work::sync::mpsc::namespace
//
//! Defines the [`Mpsc`] namespace.
//

#[cfg(feature = "std")]
use crate::{MpscReceiver, MpscSender, MpscSyncSender};
#[cfg(feature = "std")]
use std::sync::mpsc::{channel, sync_channel};

#[doc = crate::_tags!(concurrency namespace)]
/// Multi-producer, single-consumer channel operations.
#[doc = crate::_doc_location!("work/sync/mpsc")]
#[derive(Debug)]
pub struct Mpsc;

#[cfg(feature = "std")]
#[cfg_attr(nightly_doc, doc(cfg(feature = "std")))]
impl Mpsc {
    /// Creates a new asynchronous channel, returning the sender/receiver halves.
    ///
    /// See `std::sync::mpsc::`[`channel`].
    #[must_use]
    pub fn channel<T>() -> (MpscSender<T>, MpscReceiver<T>) {
        channel()
    }

    /// Creates a new synchronous, bounded channel.
    ///
    /// See `std::sync::mpsc::`[`sync_channel`].
    #[must_use]
    pub fn sync_channel<T>(bound: usize) -> (MpscSyncSender<T>, MpscReceiver<T>) {
        sync_channel(bound)
    }
}