ratatui_toolkit::widgets::markdown_preview

Struct CollapseState

pub struct CollapseState { /* private fields */ }

Available on crate feature markdown-preview only.

Expand description

Collapse state for markdown sections.

Tracks which sections are collapsed and their hierarchy.

Implementations§

Source §

impl CollapseState

Constructor for CollapseState.

Source

pub fn new() -> CollapseState

Create a new collapse state with no collapsed sections.

Source §

impl CollapseState

Clear hierarchy method for CollapseState.

Source

pub fn clear_hierarchy(&mut self)

Clear section hierarchy (called when content changes).

Source §

impl CollapseState

Collapse all sections method for CollapseState.

Source

pub fn collapse_all(&mut self)

Collapse all sections.

Source §

impl CollapseState

Collapse section method for CollapseState.

Source

pub fn collapse_section(&mut self, section_id: usize)

Collapse a section.

§Arguments

section_id - The ID of the section to collapse.

Source §

impl CollapseState

Expand all sections method for CollapseState.

Source

pub fn expand_all(&mut self)

Expand all sections.

Source §

impl CollapseState

Expand section method for CollapseState.

Source

pub fn expand_section(&mut self, section_id: usize)

Expand a section.

§Arguments

section_id - The ID of the section to expand.

Source §

impl CollapseState

Get hierarchy method for CollapseState.

Source

pub fn get_hierarchy(&self, section_id: usize) -> Option<(u8, Option<usize>)>

Get the hierarchy information for a section.

§Arguments

section_id - The section ID to look up

§Returns

Some((level, parent_id)) if the section exists, None otherwise.

Source §

impl CollapseState

Is section collapsed method for CollapseState.

Source

pub fn is_section_collapsed(&self, section_id: usize) -> bool

Check if a section is collapsed (directly or via parent hierarchy).

§Arguments

section_id - The ID of the section to check.

§Returns

true if the section or any of its parent sections is collapsed.

Source §

impl CollapseState

Register section method for CollapseState.

Source

pub fn register_section( &mut self, section_id: usize, level: u8, parent_section_id: Option<usize>, )

Register section hierarchy (called during parsing).

§Arguments

section_id - The ID of the section.
level - The heading level (1-6).
parent_section_id - The parent section’s ID, if any.

Source §

impl CollapseState

Set section collapsed method for CollapseState.

Source

pub fn set_section_collapsed(&mut self, section_id: usize, collapsed: bool)

Set the collapse state of a section.

§Arguments

section_id - The ID of the section.
collapsed - Whether the section should be collapsed.

Source §

impl CollapseState

Toggle section collapse method for CollapseState.

Source

pub fn toggle_section(&mut self, section_id: usize)

Toggle the collapse state of a section.

§Arguments

section_id - The ID of the section to toggle.

Trait Implementations§

Source §

impl Clone for CollapseState

Source §

fn clone(&self) -> CollapseState

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for CollapseState

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for CollapseState

Default trait implementation for CollapseState.

Source §

fn default() -> CollapseState

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl UnwindSafe for CollapseState

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

impl<T> ToOwned for T
where T: Clone,

Source §

type Owned = T

The resulting type after obtaining ownership.

Source §

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

Source §

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

Source §

impl<T, U> TryFrom for T
where U: Into<T>,

Source §

type Error = Infallible

The type returned in the event of a conversion error.

Source §

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Source §

impl<T> WithSubscriber for T

Source §

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Source §

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

CollapseState

Struct CollapseState Copy item path

Implementations§

impl CollapseState

pub fn new() -> CollapseState

impl CollapseState

pub fn clear_hierarchy(&mut self)

impl CollapseState

pub fn collapse_all(&mut self)

impl CollapseState

pub fn collapse_section(&mut self, section_id: usize)

§Arguments

impl CollapseState

pub fn expand_all(&mut self)

impl CollapseState

pub fn expand_section(&mut self, section_id: usize)

§Arguments

impl CollapseState

pub fn get_hierarchy(&self, section_id: usize) -> Option<(u8, Option<usize>)>

§Arguments

§Returns

impl CollapseState

pub fn is_section_collapsed(&self, section_id: usize) -> bool

§Arguments

§Returns

impl CollapseState

pub fn register_section( &mut self, section_id: usize, level: u8, parent_section_id: Option<usize>, )

§Arguments

impl CollapseState

pub fn set_section_collapsed(&mut self, section_id: usize, collapsed: bool)

§Arguments

impl CollapseState

pub fn toggle_section(&mut self, section_id: usize)

§Arguments

Trait Implementations§

impl Clone for CollapseState

fn clone(&self) -> CollapseState

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

impl Debug for CollapseState

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

impl Default for CollapseState

fn default() -> CollapseState

Auto Trait Implementations§

impl Freeze for CollapseState

impl RefUnwindSafe for CollapseState

impl Send for CollapseState

impl Sync for CollapseState

impl Unpin for CollapseState

impl UnsafeUnpin for CollapseState

impl UnwindSafe for CollapseState

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

Struct CollapseState

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,