Struct unsegen_pager::PagerContent

pub struct PagerContent<L: PagerLine, D: LineDecorator> { /* fields omitted */ }

A collection of PagerLines including information about the highlighting state and (if present) a LineDecorator.

Use from_lines or from_file to build an initial content and add highlighter and decorator using with_highlighter and with_decorator.

Methods

impl<L: PagerLine> PagerContent<L, NoDecorator<L>>

pub fn from_lines(storage: Vec<L>) -> Self

Create a simple PagerContent from a ordered collection of lines. The lines the Vec will be displayed top to bottom from beginning to end.

impl PagerContent<String, NoDecorator<String>>

pub fn from_file<F: AsRef<Path>>(file_path: F) -> Result<Self>

Try to load lines (as strings) from the given file as the lines of PagerContent.

impl<L, D> PagerContent<L, D> where
    L: PagerLine,
    D: LineDecorator<Line = L>, 

pub fn with_highlighter<HN: Highlighter>(
    self,
    highlighter: &HN
) -> PagerContent<L, D>

Add a Highlighter to PagerContent that previously did not have one.

impl<L> PagerContent<L, NoDecorator<L>> where
    L: PagerLine, 

pub fn with_decorator<DN: LineDecorator<Line = L>>(
    self,
    decorator: DN
) -> PagerContent<L, DN>

Add a Decorator to PagerContent that previously did not have one.

impl<L, D> PagerContent<L, D> where
    L: PagerLine,
    D: LineDecorator<Line = L>, 

pub fn view<'a, I: Into<LineIndex> + Clone, R: RangeBounds<I>>(
    &'a self,
    range: R
) -> impl DoubleEndedIterator<Item = (LineIndex, &'a L)> + 'a where
    Self: Sized, 

Iterate over a specified range of lines stored.

The specified range can be larger than what the PagerContent currently holds. In that case the additional indices are simply not part of the returned iterator.

pub fn view_line<I: Into<LineIndex>>(&self, line: I) -> Option<&L>

Try to view a specific line with the given index.

pub fn set_decorator(&mut self, decorator: D)

Overwrite the current decorator with a compatible one.