Struct TCAnnotation

#[repr(C)]
pub struct TCAnnotation {
    pub entry: time_t,
    pub description: TCString,
}

***** TCAnnotation *****

TCAnnotation contains the details of an annotation.

Safety

An annotation must be initialized from a tc_.. function, and later freed with tc_annotation_free or tc_annotation_list_free.

Any function taking a *TCAnnotation 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
• ownership transfers to the called function, and the value must not be used after the call returns. In fact, the value will be zeroed out to ensure this.

TCAnnotations are not threadsafe.

typedef struct TCAnnotation {
  // Time the annotation was made.  Must be nonzero.
  time_t entry;
  // Content of the annotation.  Must not be NULL.
  TCString description;
} TCAnnotation;

Fields

entry: time_t

description: TCString

Trait Implementations

impl Default for TCAnnotation

fn default() -> Self

Returns the “default value” for a type.