Struct Inlet

pub struct Inlet { /* private fields */ }

Receives data from an external source and sends the data through a channel.

Using an Inlet yields the following benefits:

• Abstracts away the use of channels. You only need to write a coroutine that takes a parameter and yields a result.
• The coroutine does not have to be aware of termination signals, or joining threads. This functionality is handled by Inlet.
• Easy integration with other Reflux modules.

Example

 #![feature(coroutines, coroutine_trait, stmt_expr_attributes)]
 #![feature(unboxed_closures)]
 use std::sync::Arc;
 use std::sync::atomic::{AtomicBool, Ordering};
 use crossbeam_channel::Receiver;
 use reflux::add_routine;
 use reflux::Inlet;
 let stop_flag = Arc::new(AtomicBool::new(false));
 let (inlet, inlet_chan): (Inlet, Receiver<String>) = Inlet::new(
     add_routine!(#[coroutine] |_: ()| {
         yield "Hello, world".to_string()
     }), stop_flag.clone(), ());

 let data = inlet_chan.recv().unwrap();
 stop_flag.store(true, Ordering::Relaxed);
 inlet.join().unwrap();

 assert_eq!(data, "Hello, world".to_string())

Implementations

impl Inlet

pub fn new<F, C, T, I>( inlet_fn: F, stop_sig: Arc<AtomicBool>, init_data: I, ) -> (Self, Receiver<T>)

where F: Fn() -> C + Send + 'static, I: Send + 'static + Clone, C: Coroutine<I> + Send + 'static + Unpin, T: Send + 'static + From<<C as Coroutine<I>>::Yield>,

Creates a new Inlet object with an unbounded internal channel.

Parameters

• inlet_fn - A coroutine that reads and returns data from an external source. The use of the add_routine! macro is necessary when passing in an inlet_fn.
• stop_sig - A flag to signal the Inlet object to terminate

Returns

A Inlet object and a Receiver to receive data from the inlet_fn

pub fn new_bounded<F, C, T, I>( inlet_fn: F, stop_sig: Arc<AtomicBool>, init_data: I, data_limit: Option<usize>, ) -> (Self, Receiver<T>)

where F: Fn() -> C + Send + 'static, I: Send + 'static + Clone, C: Coroutine<I> + Send + 'static + Unpin, T: Send + 'static + From<<C as Coroutine<I>>::Yield>,

Creates a new Inlet object with a bounded internal channel.

Parameters

• inlet_fn - A coroutine that reads and returns data from an external source. The use of the add_routine! macro is necessary when passing in an inlet_fn.
• stop_sig - A flag to signal the Inlet object to terminate
• data_limit - An optional parameter to limit channel capacity.

Returns

A Inlet object and a Receiver to receive data from the inlet_fn

pub fn join(self) -> Result<()>

Waits for the Inlet object to finish execution