Struct Line 

pub struct Line { /* private fields */ }

Available on crate feature line_token only.

A Line from which a Token can be acquired.

Thread safety

Line is thread-safe and can be shared across threads via Arc:

use std::sync::Arc;
use operation_queue::line_token::Line;

fn assert_send_sync<T: Send + Sync>() {}
assert_send_sync::<Line>();

Implementations

impl Line

pub fn new() -> Line

Instantiates a new Line.

pub async fn status(&self) -> LineStatus

Retrieve the current status of the Line, i.e. whether it’s currently free or not.

Unlike try_acquire_token, this method does not attempt to lock the line if it’s free, and does not generate a Token. If the line is busy, it returns a future the consumer can use to wait till the line becomes free again.

pub async fn try_acquire_token<'l>(&'l self) -> AcquireOutcome<'l>

Attempts to acquire a Token for this line.

The Token automatically releases the line upon leaving the current scope and getting dropped.

If a Token has already been acquired for this line, a future to await is returned instead. It resolves when the current token holder has finished handling the current error and releases the line.

Trait Implementations

impl Default for Line

fn default() -> Line

Returns the “default value” for a type.