Struct Annotation 

pub struct Annotation {
    pub id: String,
    pub turn_id: String,
    pub resource: Uri,
    pub range: Option<TextRange>,
    pub resolved: bool,
    pub entries: Vec<AnnotationEntry>,
    pub meta: Option<JsonObject>,
}

A conversation anchored to a specific file produced by a specific turn, optionally narrowed to a range within that file.

{@link turnId} anchors the annotation to the file versions that turn produced, so a later turn that rewrites the same file does not silently invalidate the annotation’s anchor — clients can resolve {@link resource} and {@link range} against the turn’s changeset. When {@link range} is omitted the annotation is anchored to the entire file.

Every annotation MUST contain at least one {@link AnnotationEntry}. An {@link AnnotationsSetAction} that creates an annotation therefore carries its mandatory first entry, and removing the last remaining entry collapses the annotation via {@link AnnotationsRemovedAction} rather than leaving an empty annotation behind.

Fields

id: String

Stable identifier within the annotations channel. Assigned by the client that dispatches the creating {@link AnnotationsSetAction}.

turn_id: String

Turn that produced the file versions this annotation is anchored to. Matches a {@link Turn.id} on the owning session.

resource: Uri

The file the annotation is anchored to.

range: Option<TextRange>

Range within {@link resource} the annotation is anchored to. When omitted the annotation is anchored to the entire file.

resolved: bool

Whether the annotation has been resolved. Newly created annotations are always unresolved (false); a client marks an annotation resolved (or re-opens it) by dispatching an {@link AnnotationsUpdatedAction} carrying the updated flag (or an {@link AnnotationsSetAction} when replacing the whole annotation).

entries: Vec<AnnotationEntry>

Entries in this annotation, in dispatch order (oldest first). MUST contain at least one entry.

meta: Option<JsonObject>

Producer-defined opaque metadata, surfaced to tooling but not interpreted by the protocol.

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 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