Struct Annotation

pub struct Annotation {
    pub owner: UserRef,
    pub target: EntityRef,
    pub loved: bool,
    pub rating: Option<u8>,
    pub note: Option<String>,
    pub tags: BTreeSet<String>,
    pub created_at: u64,
    pub updated_at: u64,
}

Everything one person said about one entity.

One record per target rather than one per fact: a favourite, a rating, a note and a set of tags are four ways of having an opinion, not four features, and keeping them together is what makes copying what was said about an album onto another album a single operation.

Fields

owner: UserRef

Whose opinion it is.

target: EntityRef

What it is about.

loved: bool

A favourite.

rating: Option<u8>

One to five stars, or nothing said.

note: Option<String>

Free text, as long as the user cares to make it.

tags: BTreeSet<String>

Free labels: “to rip again”, “vinyl”, “for the car”.

created_at: u64

When it was first written (Unix epoch, seconds).

updated_at: u64

When it was last touched.

Implementations

impl Annotation

pub fn is_empty(&self) -> bool

true when the record says nothing at all and can be dropped.

Removing the last thing said about an album must remove the record, not leave an empty one that a listing would then have to filter out — and that an export would carry for ever.

Trait Implementations

impl Clone for Annotation

fn clone(&self) -> Annotation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Annotation

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

Formats the value using the given formatter.

impl Default for Annotation

fn default() -> Annotation

Returns the “default value” for a type.

impl PartialEq for Annotation

fn eq(&self, other: &Annotation) -> 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 StructuralPartialEq for Annotation