Struct fp_rust::cor::Cor

pub struct Cor<RETURN: 'static, RECEIVE: 'static> { /* fields omitted */ }

The Cor implements a PythonicGenerator-like Coroutine.

Arguments

• RETURN - The generic type of returned data
• RECEIVE - The generic type of received data

Remarks

It could be sync or async up to your usages, and it could use yield_from to send a value to another Cor object and get the response, and use yield_ref()/yield_none() to return my response to the callee of mine.

NOTE: Beware the deadlock if it’s sync(waiting for each other), except the entry point.

Implementations

impl<RETURN: Send + Sync + 'static, RECEIVE: Send + Sync + 'static> Cor<RETURN, RECEIVE>

pub fn new(
    effect: impl FnMut(Arc<Mutex<Cor<RETURN, RECEIVE>>>) + Send + Sync + 'static
) -> Cor<RETURN, RECEIVE>

Generate a new Cor with the given FnMut function for the execution of this Cor.

Arguments

• effect - The given FnMut, the execution code of Cor.

pub fn new_with_mutex(
    effect: impl FnMut(Arc<Mutex<Cor<RETURN, RECEIVE>>>) + Send + Sync + 'static
) -> Arc<Mutex<Cor<RETURN, RECEIVE>>>

Generate a new Arc<Mutex<Cor<RETURN, RECEIVE>>> with the given FnMut function for the execution of this Cor.

Arguments

• effect - The given FnMut, the execution code of Cor.

pub fn yield_from<RETURNTARGET: Send + Sync + 'static, RECEIVETARGET: Send + Sync + 'static>(
    this: Arc<Mutex<Cor<RETURN, RECEIVE>>>,
    target: Arc<Mutex<Cor<RETURNTARGET, RECEIVETARGET>>>,
    sent_to_inside: Option<RECEIVETARGET>
) -> Option<RETURNTARGET>

Make this sends a given Option<RECEIVETARGET> to target, and this method returns the Option<RETURNTARGET> response from target.

Arguments

• this - The sender when sending sent_to_inside to target.
• target - The receiver of value sent_to_inside sent by this.
• sent_to_inside - The value sent by this and received by target.

Remarks

This method is implemented according to some coroutine/generator implementations, such as Python, Lua, ECMASript…etc.

pub fn yield_none(this: Arc<Mutex<Cor<RETURN, RECEIVE>>>) -> Option<RECEIVE>

Make this returns a given None::<RETURN> to its callee Cor, and this method returns the Option<RECEIVE> value given from outside.

Arguments

• this - The sender when sending given_to_outside to callee Cor.

Remarks

This method is implemented according to some coroutine/generator implementations, such as Python, Lua, ECMASript…etc.

pub fn yield_ref(
    this: Arc<Mutex<Cor<RETURN, RECEIVE>>>,
    given_to_outside: Option<RETURN>
) -> Option<RECEIVE>

Make this returns a given Option<RETURN> given_to_outside to its callee Cor, and this method returns the Option<RECEIVE> value given from outside.

Arguments

• this - The sender when sending given_to_outside to callee Cor.
• given_to_outside - The value sent by this and received by target.

Remarks

This method is implemented according to some coroutine/generator implementations, such as Python, Lua, ECMASript…etc.

pub fn start(this: Arc<Mutex<Cor<RETURN, RECEIVE>>>)

Start this Cor.

Arguments

• this - The target Cor to start.

NOTE: Beware the deadlock if it’s sync(waiting for each other), except the entry point.

pub fn set_async(&mut self, is_async: bool)

Setup async or not. Default async: true

Arguments

• async - async when true, otherwise sync.

NOTE: Beware the deadlock if it’s sync(waiting for each other), except the entry point.

pub fn is_started(&self) -> bool

Did this Cor start? Return true when it did started (no matter it has stopped or not)

pub fn is_alive(&self) -> bool

Is this Cor alive? Return true when it has started and not stopped yet.

pub fn stop(&mut self)

Stop Cor. This will make self.is_alive() returns false, and all yield_from() from this Cor as target will return None::<RETURN>. (Because it has stopped :P, that’s reasonable)

Trait Implementations

impl<RETURN: Clone + 'static, RECEIVE: Clone + 'static> Clone for Cor<RETURN, RECEIVE>

fn clone(&self) -> Cor<RETURN, RECEIVE>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.