Struct scambio::Left

pub struct Left<L, R> { /* fields omitted */ }

An exchange endpoint for value transfers.

Every exchange consists of two halves, Left and Right, which can transfer data between each other one by one. At most one data item is stored per endpoint half.

Implementations

impl<L, R> Left<L, R>

pub fn is_closed(&self) -> bool

Has the other end been dropped?

pub async fn send<'_>(&'_ mut self, value: L) -> Result<(), L>

Send a value to Right.

If Right has been dropped, the value will be returned.

pub async fn receive<'_>(&'_ mut self) -> Option<R>

Receive a value from Right.

If Right has been dropped, None will be returned.

pub fn poll_receive(&mut self, cx: &mut Context) -> Poll<Option<R>>

Receive a value from Right if available.

If Right has been dropped, Poll::Ready(None) will be returned. If no value is available, Poll::Pending will be returned and Left will be woken up once a value can be received for Right.

pub fn poll_send_ready(&mut self, cx: &mut Context) -> Poll<()>

Check if there is capacity to send a data item to Right.

pub fn send_now(&mut self, value: L) -> Result<(), Error<L>>

Try to send data to Right.

If Right has been dropped or there is already a pending data item for Right the data will be returned to the caller.

Use Left::poll_send_ready to ensure there is capacity available.

Trait Implementations

impl<L, R> Debug for Left<L, R>

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

Formats the value using the given formatter.

impl<L, R> Drop for Left<L, R>

fn drop(&mut self)

Executes the destructor for this type.

impl<L, R> Unpin for Left<L, R>