Struct MarkdownReviewState 

pub struct MarkdownReviewState { /* private fields */ }

Persistent state for crate::MarkdownReviewWidget.

Implementations

impl MarkdownReviewState

pub fn interaction_phase(&self) -> InteractionPhase

pub fn handle_input( &mut self, input: ReviewInput, ) -> Result<InputOutcome<MarkdownReviewEvent>, MarkdownReviewError>

pub fn command_for_key(&self, key: KeyEvent) -> Option<MarkdownReviewCommand>

pub fn command_context(&self) -> CommandContext

pub fn set_capabilities(&mut self, capabilities: ReviewCapabilities)

pub fn command_enabled(&self, command: &MarkdownReviewCommand) -> bool

pub fn handle_command( &mut self, command: impl Into<MarkdownReviewCommand>, ) -> Result<InputOutcome<MarkdownReviewEvent>, MarkdownReviewError>

impl MarkdownReviewState

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

Creates ready state from an immutable parsed document.

pub fn with_theme(document: Arc<MarkdownDocument>, theme: ReviewTheme) -> Self

Creates state with an explicit shared neutral theme.

pub const fn session(&self) -> &MarkdownReviewSession

pub const fn session_mut(&mut self) -> &mut 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 const fn focus(&self) -> MarkdownFocusPane

pub const fn scroll_offset(&self) -> usize

pub const fn outline_scroll_offset(&self) -> usize

pub const fn cursor_position(&self) -> Option<Position>

pub const fn is_dirty(&self) -> bool

pub const fn mark_dirty(&mut self)

pub const fn theme(&self) -> &ReviewTheme

Returns the active renderer-neutral theme.

pub const fn highlight_stats(&self) -> HighlightStats

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

Replaces the parsed snapshot and reconciles all existing comments.

pub fn set_theme(&mut self, theme: ReviewTheme)

pub const fn options(&self) -> &ReviewOptions

pub fn keybindings(&self) -> &[KeyBinding<MarkdownReviewCommand>]

pub fn set_keybindings( &mut self, bindings: impl Into<Vec<KeyBinding<MarkdownReviewCommand>>>, )

pub fn set_options(&mut self, options: ReviewOptions)

pub fn theme_choices(&self) -> &[ThemeChoice]

pub fn set_theme_choices(&mut self, themes: impl Into<Arc<[ThemeChoice]>>)

Trait Implementations

impl Debug for MarkdownReviewState

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

Formats the value using the given formatter.