Struct Pager 

pub struct Pager { /* private fields */ }

Pages content through an external pager.

Implementations

impl Pager

pub fn new() -> Self

Creates a pager using $PAGER or the platform default.

Examples found in repository

examples/output_dynamic.rs (line 77)

fn pager() -> Result<()> {
    use sparcli::Pager;
    let lines = (1..=200)
        .map(|n| Line::raw(format!("line {n}")))
        .collect::<Vec<_>>();
    Pager::new().page(&Rendered::new(lines))
}

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

Overrides the pager command (whitespace-split, no shell).

pub fn always(self) -> Self

Pages even when output is not a terminal.

pub fn page(&self, content: &impl Renderable) -> Result<()>

Pages content, falling back to a direct print off-terminal.

Errors

Returns SparcliError::Io if spawning the pager or writing fails, or SparcliError::Config if the pager command is empty.

Examples found in repository

examples/output_dynamic.rs (line 77)

fn pager() -> Result<()> {
    use sparcli::Pager;
    let lines = (1..=200)
        .map(|n| Line::raw(format!("line {n}")))
        .collect::<Vec<_>>();
    Pager::new().page(&Rendered::new(lines))
}

Trait Implementations

impl Default for Pager

fn default() -> Self

Returns the “default value” for a type.