Enum MarkdownSource 

pub enum MarkdownSource {
    String(String),
    File {
        path: PathBuf,
        content: String,
    },
}

Available on crate feature markdown-preview only.

Represents the source of markdown content.

This enum provides a unified interface for working with markdown content that can come from either a static string or a file on disk.

Variants

String(String)

Static string content (no auto-reload support).

File

File-based content with auto-reload support.

Fields

path: PathBuf

Path to the markdown file.

content: String

Cached content from the file.

Implementations

impl MarkdownSource

pub fn from_file(path: impl AsRef<Path>) -> Result<MarkdownSource, Error>

Create a new MarkdownSource from a file path.

Reads the file content immediately and caches it.

Arguments

• path - Path to the markdown file.

Errors

Returns an io::Error if the file cannot be read.

impl MarkdownSource

Constructor for creating a MarkdownSource from a string.

pub fn from_string(s: impl Into<String>) -> MarkdownSource

Create a new MarkdownSource from a string.

Arguments

• s - The markdown string content.

impl MarkdownSource

Method to get the content of a MarkdownSource.

pub fn content(&self) -> &str

Get the current content of the markdown source.

For string sources, this returns the original string. For file sources, this returns the cached content.

impl MarkdownSource

Method to check if a MarkdownSource is file-based.

pub fn is_file(&self) -> bool

Check if this source is file-based.

impl MarkdownSource

Method to check if a MarkdownSource is string-based.

pub fn is_string(&self) -> bool

Check if this source is string-based.

impl MarkdownSource

Method to get the file path of a MarkdownSource.

pub fn path(&self) -> Option<&Path>

Get the file path if this is a file-based source.

Returns None for string sources.

impl MarkdownSource

Method to reload content from a file.

pub fn reload(&mut self) -> Result<bool, Error>

Reload the content from the file.

For string sources, this is a no-op and returns Ok(false). For file sources, this re-reads the file and returns Ok(true) if the content has changed.

Errors

Returns an io::Error if the file cannot be read.

impl MarkdownSource

Method to set content directly on a MarkdownSource.

pub fn set_content(&mut self, new_content: impl Into<String>) -> bool

Set the content directly (for string sources).

This is useful for updating string-based sources programmatically. For file sources, this updates the cached content but does not write to disk.

Returns true if the content was changed.

Trait Implementations

impl Clone for MarkdownSource

fn clone(&self) -> MarkdownSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MarkdownSource

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

Formats the value using the given formatter.

impl Default for MarkdownSource

Default trait implementation for MarkdownSource.

fn default() -> MarkdownSource

Returns the “default value” for a type.

impl From<&str> for MarkdownSource

From<&str> trait implementation for MarkdownSource.

fn from(s: &str) -> MarkdownSource

Converts to this type from the input type.

impl From<String> for MarkdownSource

From trait implementation for MarkdownSource.

fn from(s: String) -> MarkdownSource

Converts to this type from the input type.