Struct MarkdownRendererState 

pub struct MarkdownRendererState { /* private fields */ }

State for a MarkdownRenderer component.

Contains the markdown source, scroll position, and display options.

Example

use envision::component::MarkdownRendererState;

let state = MarkdownRendererState::new()
    .with_source("# Title\n\nBody text.")
    .with_title("Document");

assert_eq!(state.source(), "# Title\n\nBody text.");
assert_eq!(state.title(), Some("Document"));

Implementations

impl MarkdownRendererState

pub fn new() -> Self

Creates a new empty markdown renderer state.

Example

use envision::component::MarkdownRendererState;

let state = MarkdownRendererState::new();
assert!(state.source().is_empty());
assert_eq!(state.scroll_offset(), 0);

pub fn with_source(self, source: impl Into<String>) -> Self

Sets the markdown source (builder pattern).

Example

use envision::component::MarkdownRendererState;

let state = MarkdownRendererState::new()
    .with_source("# Hello");
assert_eq!(state.source(), "# Hello");

pub fn with_title(self, title: impl Into<String>) -> Self

Sets the title (builder pattern).

Example

use envision::component::MarkdownRendererState;

let state = MarkdownRendererState::new()
    .with_title("Preview");
assert_eq!(state.title(), Some("Preview"));

pub fn with_show_source(self, show: bool) -> Self

Sets the show_source flag (builder pattern).

Example

use envision::component::MarkdownRendererState;

let state = MarkdownRendererState::new()
    .with_show_source(true);
assert!(state.show_source());

pub fn source(&self) -> &str

Returns the markdown source text.

Example

use envision::component::MarkdownRendererState;

let state = MarkdownRendererState::new()
    .with_source("hello");
assert_eq!(state.source(), "hello");

pub fn set_source(&mut self, source: impl Into<String>)

Sets the markdown source text and resets scroll to the top.

Example

use envision::component::MarkdownRendererState;

let mut state = MarkdownRendererState::new();
state.set_source("# New");
assert_eq!(state.source(), "# New");
assert_eq!(state.scroll_offset(), 0);

pub fn title(&self) -> Option<&str>

Returns the title.

Example

use envision::component::MarkdownRendererState;

let state = MarkdownRendererState::new()
    .with_title("Title");
assert_eq!(state.title(), Some("Title"));

pub fn set_title(&mut self, title: Option<String>)

Sets the title.

Example

use envision::component::MarkdownRendererState;

let mut state = MarkdownRendererState::new();
state.set_title(Some("Document".to_string()));
assert_eq!(state.title(), Some("Document"));

pub fn show_source(&self) -> bool

Returns whether the raw source view is active.

Example

use envision::component::MarkdownRendererState;

let state = MarkdownRendererState::new();
assert!(!state.show_source());

pub fn set_show_source(&mut self, show: bool)

Sets whether to show raw source.

Example

use envision::component::MarkdownRendererState;

let mut state = MarkdownRendererState::new();
state.set_show_source(true);
assert!(state.show_source());

pub fn scroll_offset(&self) -> usize

Returns the current scroll offset.

Example

use envision::component::MarkdownRendererState;

let state = MarkdownRendererState::new();
assert_eq!(state.scroll_offset(), 0);

pub fn set_scroll_offset(&mut self, offset: usize)

Sets the scroll offset.

Example

use envision::component::MarkdownRendererState;

let mut state = MarkdownRendererState::new()
    .with_source("line1\nline2\nline3\nline4\nline5");
state.set_scroll_offset(2);
assert_eq!(state.scroll_offset(), 2);

pub fn update(&mut self, msg: MarkdownRendererMessage)

Updates the state with a message.

Example

use envision::component::{MarkdownRendererState, MarkdownRendererMessage};

let mut state = MarkdownRendererState::new()
    .with_source("line 1\nline 2");
state.update(MarkdownRendererMessage::ScrollDown);
assert_eq!(state.scroll_offset(), 1);

Trait Implementations

impl Clone for MarkdownRendererState

fn clone(&self) -> MarkdownRendererState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MarkdownRendererState

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

Formats the value using the given formatter.

impl Default for MarkdownRendererState

fn default() -> MarkdownRendererState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MarkdownRendererState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MarkdownRendererState

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

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 MarkdownRendererState