Struct MarkdownReview 

pub struct MarkdownReview { /* private fields */ }

Mutable collection of Markdown review comments.

Implementations

impl MarkdownReview

pub fn add_comment( &mut self, anchor: MarkdownAnchor, body: impl Into<String>, ) -> u64

Adds a comment with the context available in its anchor.

pub fn add_comment_with_context( &mut self, anchor: MarkdownAnchor, context: MarkdownCommentContext, body: impl Into<String>, ) -> u64

Adds a comment with an explicitly captured context.

pub fn add_comment_for_target( &mut self, document: &MarkdownDocument, target: MarkdownTargetId, body: impl Into<String>, ) -> Option<u64>

Creates an anchor and captures all context for a document target.

pub fn edit_comment(&mut self, id: u64, body: impl Into<String>) -> bool

Changes a comment body, returning whether the ID existed.

pub fn remove_comment(&mut self, id: u64) -> Option<MarkdownReviewComment>

Removes a comment, returning it if present.

pub fn comment(&self, id: u64) -> Option<&MarkdownReviewComment>

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn outdated_count(&self) -> usize

pub fn comments(&self) -> &[MarkdownReviewComment]

Returns comments in insertion order.

pub fn iter(&self) -> impl Iterator<Item = &MarkdownReviewComment>

Iterates over comments in insertion order.

pub fn comments_for_anchor<'a>( &'a self, anchor: &MarkdownAnchor, ) -> impl DoubleEndedIterator

Returns comments associated with an exact durable anchor.

pub fn comments_for_target<'a>( &'a self, document: &'a MarkdownDocument, target: MarkdownTargetId, ) -> IntoIter<&'a MarkdownReviewComment>

Returns comments associated with a target in document.

pub fn most_recent_comment_id(&self) -> Option<u64>

Returns the most recently inserted comment ID.

pub fn clear(&mut self)

Removes every comment without resetting the monotonic ID counter.

pub fn reconcile(&mut self, document: &MarkdownDocument)

Reattaches comments to a replacement document and marks misses outdated.

pub fn submission( &self, decision: MarkdownReviewDecision, ) -> MarkdownReviewSubmission

Produces a submission. Call Self::try_submission when comments may have been inserted without a session draft.

pub fn try_submission( &self, decision: MarkdownReviewDecision, ) -> Result<MarkdownReviewSubmission, MarkdownReviewError>

Produces a submission after validating that every body is nonblank.

Errors

Returns MarkdownReviewError::BlankComment when a comment body contains no non-whitespace characters.

Trait Implementations

impl Clone for MarkdownReview

fn clone(&self) -> MarkdownReview

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MarkdownReview

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

Formats the value using the given formatter.

impl Default for MarkdownReview

fn default() -> MarkdownReview

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MarkdownReview

fn deserialize<__D>( __deserializer: __D, ) -> Result<MarkdownReview, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MarkdownReview

impl PartialEq for MarkdownReview

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MarkdownReview

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MarkdownReview