Struct kernel::workqueue::Work

#[repr(transparent)]
pub struct Work(_);

A work item.

Wraps the kernel’s C struct work_struct.

Users must add a field of this type to a structure, then implement WorkAdapter so that it can be queued for execution in a thread pool. Examples of it being used are available in the documentation for Queue.

Implementations

impl Work

pub unsafe fn new() -> Self

Creates a new instance of Work.

Safety

Callers must call either Work::init or Work::init_with_adapter before the work item can be used.

pub fn init<T: WorkAdapter<Target = T>>(
    obj: &UniqueRef<T>,
    key: &'static LockClassKey
)

Initialises the work item.

Users should prefer the init_work_item macro because it automatically defines a new lock class key.

pub fn init_with_adapter<A: WorkAdapter>(
    obj: &UniqueRef<A::Target>,
    key: &'static LockClassKey
)

Initialises the work item with the given adapter.

Users should prefer the init_work_item_adapter macro because it automatically defines a new lock class key.

pub fn cancel(&self)

Cancels the work item.

It is ok for this to be called when the work is not queued.