Struct Inputs 

pub struct Inputs<T, const N: usize = 0> { /* private fields */ }

Implementations

impl<T, const N: usize> Inputs<T, N>

pub fn close(&mut self)

pub fn disconnect(&mut self)

pub fn direction(&self) -> PortDirection

pub fn state(&self) -> PortState

pub fn is_empty(&self) -> bool

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

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

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

Examples found in repository

examples/sqrt.rs (line 18)

async fn sqrt(mut inputs: Inputs<f64>, outputs: Outputs<f64>) -> Result {
    while let Some(input) = inputs.recv().await? {
        let output = input.sqrt();
        outputs.send(output).await?;
    }
    Ok(())
}

examples/basic.rs (line 13)

pub async fn main() {
    let (outputs, mut inputs) = async_flow::Channel::bounded(1).into_inner();

    tokio::spawn(async move {
        outputs.send("value1").await.unwrap();
        outputs.send("value2").await.unwrap();
    });

    while let Some(message) = inputs.recv().await.unwrap() {
        eprintln!("recv: {}", message);
    }
}

pub async fn recv_event(&mut self) -> Result<Option<PortEvent<T>>, RecvError>

pub fn blocking_recv(&mut self) -> Result<Option<T>, RecvError>

Trait Implementations

impl<T, const N: usize> AsMut<Receiver<PortEvent<T>>> for Inputs<T, N>

fn as_mut(&mut self) -> &mut Receiver<PortEvent<T>>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T, const N: usize> AsRef<Receiver<PortEvent<T>>> for Inputs<T, N>

fn as_ref(&self) -> &Receiver<PortEvent<T>>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T, const N: usize> Debug for Inputs<T, N>

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

Formats the value using the given formatter.

impl<T: Default, const N: usize> Default for Inputs<T, N>

fn default() -> Inputs<T, N>

Returns the “default value” for a type.

impl<T, const N: usize> From<Receiver<PortEvent<T>>> for Inputs<T, N>

fn from(input: Receiver<PortEvent<T>>) -> Self

Converts to this type from the input type.

impl<T: Send + 'static, const N: usize> InputPort<T> for Inputs<T, N>

fn is_empty(&self) -> bool

Checks if this port is empty.

fn recv<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Option<T>, RecvError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn recv_all<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Vec<T>, RecvError>> + Send + 'async_trait>>

where Self: Send + 'async_trait, 'life0: 'async_trait,

impl<T, const N: usize> MaybeLabeled for Inputs<T, N>

fn label(&self) -> Option<Cow<'_, str>>

Returns the human-readable label, if any, of the object.

fn is_labeled(&self) -> bool

Checks whether the object has a human-readable label.

impl<T, const N: usize> MaybeNamed for Inputs<T, N>

fn name(&self) -> Option<Cow<'_, str>>

Returns the name, if any, of the object.

fn is_named(&self) -> bool

Checks whether the object has a name.

impl<T: Send, const N: usize> Port<T> for Inputs<T, N>

fn close(&mut self)

Closes this port without dropping it, returning immediately.

fn direction(&self) -> PortDirection

The dataflow direction of this port.

fn state(&self) -> PortState

The current state of this port.

fn is_input(&self) -> bool

Checks whether this port is an input port.

fn is_output(&self) -> bool

Checks whether this port is an output port.

fn is_unconnected(&self) -> bool

Checks whether this port is currently unconnected.

fn is_connected(&self) -> bool

Checks whether this port is currently connected.

fn is_disconnected(&self) -> bool

Checks whether this port is currently disconnected.

fn is_closed(&self) -> bool

Checks whether this port is currently closed.

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

Returns the remaining buffer capacity of the connection.

fn max_capacity(&self) -> Option<usize>

Returns the maximum buffer capacity of the connection.