Struct Annotation 

pub struct Annotation {
    pub annotation_id: String,
    pub scope: AnnotationScope,
    pub status: AnnotationStatus,
    pub revisions: Vec<AnnotationRevision>,
    pub supersedes_annotation_id: Option<String>,
    pub supersedes_rewrite_pct: Option<u32>,
    pub visibility: VisibilityTier,
    pub resolved_from_discussion: Option<String>,
}

A stable logical annotation with revision history.

Fields

annotation_id: String

scope: AnnotationScope

status: AnnotationStatus

revisions: Vec<AnnotationRevision>

supersedes_annotation_id: Option<String>

supersedes_rewrite_pct: Option<u32>

visibility: VisibilityTier

Visibility scope. Pre-W1 annotations have no field on disk; rmp-serde fills the default (VisibilityTier::Public), preserving the pre-existing meaning (“annotations are publicly visible”).

resolved_from_discussion: Option<String>

Back-pointer set when this annotation was produced by resolving a discussion. Lets viewers jump from the annotation back to the discussion that produced it.

Implementations

impl Annotation

pub fn new( scope: AnnotationScope, kind: AnnotationKind, content: String, tags: Vec<String>, attribution: String, created_at: i64, source_hash: Option<ContentHash>, created_at_state: Option<ChangeId>, ) -> Self

pub fn current_revision(&self) -> Option<&AnnotationRevision>

pub fn current_revision_mut(&mut self) -> Option<&mut AnnotationRevision>

pub fn revise( &mut self, kind: AnnotationKind, content: String, tags: Vec<String>, attribution: String, created_at: i64, source_hash: Option<ContentHash>, created_at_state: Option<ChangeId>, ) -> &AnnotationRevision

pub fn mark_superseded(&mut self)

pub fn validate(&self) -> Result<(), ContextError>

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<'de> Deserialize<'de> for Annotation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Annotation

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 Serialize for Annotation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Annotation