Struct TCReplica

Source

pub struct TCReplica { /* private fields */ }

Expand description

***** TCReplica *****

A replica represents an instance of a user’s task data, providing an easy interface for querying and modifying that data.

§Error Handling

When a tc_replica_.. function that returns a TCResult returns TC_RESULT_ERROR, then tc_replica_error will return the error message.

§Safety

The *TCReplica returned from tc_replica_new… functions is owned by the caller and must later be freed to avoid a memory leak.

Any function taking a *TCReplica 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_replica_free, ownership of a *TCReplica remains with the caller.

Once passed to tc_replica_free, a *TCReplica becomes invalid and must not be used again.

TCReplicas are not threadsafe.

typedef struct TCReplica TCReplica;

Trait Implementations§

Source §

impl From<Replica> for TCReplica

Source §

fn from(rep: Replica) -> TCReplica

Converts to this type from the input type.

Auto Trait Implementations§

§

impl !UnwindSafe for TCReplica

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §