Struct Entity 

pub struct Entity { /* private fields */ }

The OpenTimeline Entity type

Implementations

impl Entity

pub fn from( id: Option<OpenTimelineId>, name: Name, start: Date, end: Option<Date>, tags: Option<Tags>, ) -> Result<Entity, EntityError>

Create a valid OpenTimeline Entity if it is possible to do so with the values passed in

pub fn clear_id(&mut self)

Clear the Entity’s ID

pub fn tags(&self) -> &Option<Tags>

Borrow the entity’s Tags

pub fn tags_mut(&mut self) -> &mut Option<Tags>

Mutably borrow the entity’s Tags

pub fn add_tag(&mut self, tag: Tag)

Add a tag to the entity

pub fn remove_tag(&mut self, tag: &Tag)

Remove a tag from the entity

pub fn set_tags(&mut self, tags: Tags)

Set the entity’s Tags

pub fn clear_tags(&mut self)

Clear the entity’s Tags and set to None

pub fn start(&self) -> Date

Get the entity’s start Date

pub fn set_start(&mut self, start: Date) -> Result<(), EntityError>

Set the entity’s start Date if it’ll be valid

pub fn end(&self) -> Option<Date>

Get the entity’s end Date

pub fn set_end(&mut self, end: Date) -> Result<(), EntityError>

Set the entity’s end Date if it’ll be valid

pub fn end_year_is_set(&self) -> bool

Check if the entity’s end year is set

pub fn end_year(&self) -> Option<Year>

Check if the entity’s end year is set

pub fn end_month(&self) -> Option<Month>

Check if the entity’s end month is set

pub fn end_day(&self) -> Option<Day>

Check if the entity’s end day is set

pub fn start_year(&self) -> Year

Check if the entity’s start year is set

pub fn start_month(&self) -> Option<Month>

Check if the entity’s start month is set

pub fn start_day(&self) -> Option<Day>

Check if the entity’s start day is set

pub fn matches_bool_tag_expr(&self, bool_tag_expr: &BoolTagExpr) -> bool

Whether the entity in question matches the boolean tag expression. This can be used to filter a list of entities by a boolean tag expression.

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Entity

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Entity

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl HasIdAndName for Entity

fn id(&self) -> Option<OpenTimelineId>

Get the ID

fn set_id(&mut self, id: OpenTimelineId)

Set the ID - the OpenTimelineId passed in must have been initialised, and therefore is guaranteed to be valid

fn name(&self) -> &Name

Get the name

fn set_name(&mut self, name: Name)

Set the name - the Name passed in must have been initialised, and therefore is guaranteed to be valid

impl Hash for Entity

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Entity

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Entity

fn eq(&self, other: &Entity) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Entity

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Entity

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Entity

impl StructuralPartialEq for Entity