Struct TCTask

pub struct TCTask { /* private fields */ }

***** TCTask *****

A task, as publicly exposed by this library.

A task begins in “immutable” mode. It must be converted to “mutable” mode to make any changes, and doing so requires exclusive access to the replica until the task is freed or converted back to immutable mode.

An immutable task carries no reference to the replica that created it, and can be used until it is freed or converted to a TaskMut. A mutable task carries a reference to the replica and must be freed or made immutable before the replica is freed.

All tc_task_.. functions taking a task as an argument require that it not be NULL.

When a tc_task_.. function that returns a TCResult returns TC_RESULT_ERROR, then tc_task_error will return the error message.

Safety

A task is an owned object, and must be freed with tc_task_free (or, if part of a list, with tc_task_list_free).

Any function taking a *TCTask requires:

• the pointer must not be NUL;
• the pointer must be one previously returned from a tc_… function;
• the memory referenced by the pointer must never be modified by C code; and
• except for tc_{task,task_list}_free, ownership of a *TCTask remains with the caller.

Once passed to tc_task_free, a *TCTask becomes invalid and must not be used again.

TCTasks are not threadsafe.

typedef struct TCTask TCTask;

Trait Implementations

impl From<Task> for TCTask

fn from(task: Task) -> TCTask

Converts to this type from the input type.