edamame 0.1.2

A fast TUI Markdown editor and viewer
Documentation
use std::fmt;

/// The editor's rendering and interaction mode.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum Mode {
    /// Read-only preview. No cursor shown, no raw Markdown visible.
    /// Files open in this mode.
    #[default]
    Preview,

    /// Hybrid rendered/raw editing. Cursor visible; the active line (or active
    /// table cell) is shown as raw Markdown while the rest is rendered.
    /// Entered on click or first keystroke (not scroll).
    Rendered,

    /// Entire document shown as plain Markdown text. Standard text editing.
    Raw,

    /// Inline diff review.  The buffer is replaced by a stacked diff
    /// of the pre-change rope vs. the on-disk content; the user
    /// accepts / rejects each hunk before the merged result becomes
    /// the new buffer.  Invariant: `state.mode == Mode::Diff ⟺
    /// state.diff.is_some()`, maintained by
    /// [`super::EditorState::enter_diff_mode`] /
    /// [`super::EditorState::exit_diff_mode`].
    Diff,
}

impl fmt::Display for Mode {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Mode::Preview => f.write_str("PREVIEW"),
            Mode::Rendered => f.write_str("EDIT"),
            Mode::Raw => f.write_str("RAW"),
            Mode::Diff => f.write_str("DIFF"),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn mode_display() {
        assert_eq!(Mode::Preview.to_string(), "PREVIEW");
        assert_eq!(Mode::Rendered.to_string(), "EDIT");
        assert_eq!(Mode::Raw.to_string(), "RAW");
    }

    #[test]
    fn mode_default_is_preview() {
        assert_eq!(Mode::default(), Mode::Preview);
    }
}