Struct Task

pub struct Task {
    pub index: usize,
    /* private fields */
}

Unit of work arranged by a Sequencer.

Use the standard library write! or writeln! macros for writing the output of a task. Additionally this type provides some methods for setting the color of task output.

Refer to the crate-level documentation and the documentation of the Sequencer type for the recommended patterns of launching tasks.

use oqueue::{Color::Blue, Task};

fn work(task: Task) {
    task.color(Blue);
    writeln!(task, "hello from task #{}", task.index);
}

Fields

index: usize

Index of the current task. This is a sequential counter that begins at 0 and increments by 1 for each successively started task. It may be helpful in determining what work this task is responsible for performing.

This field is read-only; writing to its value will not compile.

Implementations

impl Task

pub fn bold(&self)

Set output to appear in bold uncolored.

pub fn color(&self, color: Color)

Set output to appear in color (not bold).

pub fn bold_color(&self, color: Color)

Set output to appear bold and colored.

pub fn reset_color(&self)

Set output to non-bold uncolored.

Trait Implementations

impl Clone for Task

fn clone(&self) -> Task

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Task

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

Formats the value using the given formatter.

impl Write for Task

fn write(&mut self, b: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_all(&mut self, buf: &[u8]) -> Result<()>

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<()>

Writes a formatted string into this writer, returning any error encountered.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.

impl WriteColor for Task

fn supports_color(&self) -> bool

Returns true if and only if the underlying writer supports colors.

fn set_color(&mut self, spec: &ColorSpec) -> Result<()>

Set the color settings of the writer.

fn reset(&mut self) -> Result<()>

Reset the current color settings to their original settings.

fn is_synchronous(&self) -> bool

Returns true if and only if the underlying writer must synchronously interact with an end user’s device in order to control colors. By default, this always returns false.

fn set_hyperlink(&mut self, _link: &HyperlinkSpec<'_>) -> Result<(), Error>

Set the current hyperlink of the writer.

fn supports_hyperlinks(&self) -> bool

Returns true if and only if the underlying writer supports hyperlinks.