Struct Comment 

pub struct Comment {

    pub id: String,
    pub comment_type: CommentType,
    pub block_ref: String,
    pub range: Option<TextRange>,
    pub author: Collaborator,
    pub created: DateTime<Utc>,
    pub content: String,
    pub resolved: bool,
    pub resolved_by: Option<Collaborator>,
    pub resolved_at: Option<DateTime<Utc>>,
    pub replies: Vec<Comment>,
    pub parent_id: Option<String>,
    pub priority: Option<Priority>,
    pub tags: Vec<String>,
}

A comment or annotation on document content.

Fields

id: String

Unique identifier.

comment_type: CommentType

Type of comment.

block_ref: String

Reference to the block being commented on.

range: Option<TextRange>

Text range within the block (if applicable).

author: Collaborator

Author of the comment.

created: DateTime<Utc>

When the comment was created.

content: String

Comment content.

resolved: bool

Whether the comment has been resolved.

resolved_by: Option<Collaborator>

Who resolved the comment.

resolved_at: Option<DateTime<Utc>>

When the comment was resolved.

replies: Vec<Comment>

Replies to this comment.

parent_id: Option<String>

Parent comment ID (for nested replies).

priority: Option<Priority>

Priority level.

tags: Vec<String>

Tags or labels.

Implementations

impl Comment

pub fn new( id: impl Into<String>, block_ref: impl Into<String>, author: Collaborator, content: impl Into<String>, ) -> Self

Create a new comment.

pub fn highlight( id: impl Into<String>, block_ref: impl Into<String>, range: TextRange, author: Collaborator, color: HighlightColor, ) -> Self

Create a new highlight.

pub fn suggestion( id: impl Into<String>, block_ref: impl Into<String>, range: TextRange, author: Collaborator, original: impl Into<String>, suggested: impl Into<String>, ) -> Self

Create a new suggestion.

pub fn reaction( id: impl Into<String>, block_ref: impl Into<String>, author: Collaborator, emoji: impl Into<String>, ) -> Self

Create a reaction.

pub fn with_range(self, range: TextRange) -> Self

Set the text range.

pub fn with_priority(self, priority: Priority) -> Self

Set priority.

pub fn with_tag(self, tag: impl Into<String>) -> Self

Add a tag.

pub fn add_reply(&mut self, reply: Comment)

Add a reply.

pub fn resolve(&mut self, by: Collaborator)

Resolve the comment.

pub fn unresolve(&mut self)

Unresolve the comment.

pub fn is_suggestion(&self) -> bool

Check if this is a suggestion.

pub fn suggestion_status(&self) -> Option<SuggestionStatus>

Get the suggestion status if this is a suggestion.

pub fn accept_suggestion(&mut self) -> bool

Accept a suggestion.

Returns true if the suggestion was accepted, false if this is not a suggestion.

pub fn reject_suggestion(&mut self) -> bool

Reject a suggestion.

Returns true if the suggestion was rejected, false if this is not a suggestion.

Trait Implementations

impl Clone for Comment

fn clone(&self) -> Comment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Comment

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Comment

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Comment

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

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 Comment