Struct MarkdownReviewSession 

pub struct MarkdownReviewSession { /* private fields */ }

State for reviewing one parsed Markdown document.

Implementations

impl MarkdownReviewSession

pub fn new(document: Arc<MarkdownDocument>) -> MarkdownReviewSession

pub const fn document(&self) -> &Arc<MarkdownDocument>

pub const fn review(&self) -> &MarkdownReview

pub const fn review_mut(&mut self) -> &mut MarkdownReview

pub const fn selected_target(&self) -> Option<MarkdownTargetId>

pub fn selected_target_info(&self) -> Option<&MarkdownTarget>

pub fn selected_anchor(&self) -> Option<MarkdownAnchor>

pub const fn draft(&self) -> Option<&MarkdownCommentDraft>

pub const fn draft_mut(&mut self) -> Option<&mut MarkdownCommentDraft>

pub fn select_target(&mut self, target: MarkdownTargetId) -> bool

Selects a target from this document.

pub fn select(&mut self, target: MarkdownTargetId) -> bool

Alias for Self::select_target useful to frontend adapters.

pub fn move_by(&mut self, delta: isize) -> Option<MarkdownTargetId>

Moves one target forward or backward.

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

Returns the most recently added comment at the current selection.

pub fn selected_comments(&self) -> IntoIter<&MarkdownReviewComment>

Returns comments attached to the current selection.

pub fn move_target(&mut self, delta: isize) -> Option<MarkdownTargetId>

Moves through commentable targets, clamping at either end.

pub fn select_boundary(&mut self, last: bool) -> Option<MarkdownTargetId>

Selects the first or last target.

pub fn select_first_target(&mut self) -> Option<MarkdownTargetId>

pub fn select_last_target(&mut self) -> Option<MarkdownTargetId>

pub fn next_heading(&mut self) -> Option<MarkdownTargetId>

Selects the next heading after the current target.

pub fn previous_heading(&mut self) -> Option<MarkdownTargetId>

Selects the previous heading before the current target.

pub fn begin_draft(&mut self, editing: Option<u64>) -> bool

Begins a new draft on the current target, or edits an existing comment.

pub fn cancel_draft(&mut self)

pub fn submit_draft(&mut self) -> Option<u64>

Saves the active draft, returning its comment ID. Blank drafts are discarded.

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

pub fn edit_comment_at_selection(&mut self) -> bool

pub fn delete_comment_at_selection(&mut self) -> bool

pub fn undo_last_comment(&mut self) -> bool

Removes the most recently added comment, if there is one.

pub fn clear_review(&mut self)

pub fn replace_document(&mut self, document: Arc<MarkdownDocument>)

Replaces the document, reconciles comments, and preserves selection when possible.

pub fn set_document(&mut self, document: Arc<MarkdownDocument>)

Alias for Self::replace_document used by host adapters.

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

Builds a submission for an explicit decision.

pub fn submit( &self, decision: MarkdownReviewDecision, ) -> Result<MarkdownReviewEvent, MarkdownReviewError>

Builds an explicit submission event for either decision.

Errors

Returns an error when a comment body is blank.

pub fn approve(&self) -> Result<MarkdownReviewEvent, MarkdownReviewError>

Builds an explicit approval event.

Errors

Returns an error when a comment body is blank.

pub fn request_changes( &self, ) -> Result<MarkdownReviewEvent, MarkdownReviewError>

Builds an explicit request-changes event.

Errors

Returns an error when a comment body is blank.

pub fn approve_submission( &self, ) -> Result<MarkdownReviewSubmission, MarkdownReviewError>

Builds an explicit approval submission.

Errors

Returns an error when a comment body is blank.

pub fn request_changes_submission( &self, ) -> Result<MarkdownReviewSubmission, MarkdownReviewError>

Builds an explicit request-changes submission.

Errors

Returns an error when a comment body is blank.

pub fn cancel(&self) -> MarkdownReviewEvent

pub fn copy_formatted( &self, decision: MarkdownReviewDecision, ) -> MarkdownReviewEvent

Trait Implementations

impl Clone for MarkdownReviewSession

fn clone(&self) -> MarkdownReviewSession

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MarkdownReviewSession

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

Formats the value using the given formatter.