[][src]Struct clockctrl::Target

pub struct Target {
    pub interval: Option<Interval>,
    pub fence: Option<Box<dyn Fn(Arc<Barrier>) + Send + 'static>>,
}

Represents a single clock target

Don't construct this object manually, get a mutable builder reference from Clockctrl::setup()!

Fields

interval: Option<Interval>

Specify an interval which dictates scheduling of a task

fence: Option<Box<dyn Fn(Arc<Barrier>) + Send + 'static>>

If Interval::Stepped, provide a fence to step the clock with

Methods

impl Target[src]

pub fn set(&mut self, iv: Interval) -> &mut Self[src]

Set the interval at which this clock will be controlled

pub fn fence<F: 'static>(&mut self, f: F) -> &mut Self where
    F: Fn(Arc<Barrier>) + Send
[src]

Setup a fence which will clock control the associated task

The provided function is called once, on a detached task, and is expected to block the task with block_on, which can then do async operation.

clc
    .setup(MyTasks::TaskA)
    .set(Interval::Stepped)
    .fence(|b| {
        task::block_on(async move {
            b.wait().await;
        });
    });

Trait Implementations

impl Default for Target[src]

Auto Trait Implementations

impl !RefUnwindSafe for Target

impl Send for Target

impl !Sync for Target

impl Unpin for Target

impl !UnwindSafe for Target

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.