Struct minus::Pager

pub struct Pager {
    pub lines: String,
    pub line_numbers: LineNumbers,
    pub prompt: String,
    // some fields omitted
}

/ A struct containing basic configurations for the pager. This is used by all initializing functions

Example

With any async runtime

 let pager = minus::Pager::new().set_text("Hello").set_prompt("Example").finish();

For static output

 let pager = minus::Pager::new().set_text("Hello").set_prompt("Example");

Fields

lines: String

The output that is displayed

line_numbers: LineNumbers

Configuration for line numbers. See LineNumbers

prompt: String

Implementations

impl Pager

#[must_use]pub fn new() -> Pager

Initialize a new pager configuration

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

Set the output text to this t

#[must_use]pub fn set_line_numbers(self, l: LineNumbers) -> Self

Set line number to this setting

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

Set the prompt to t

#[must_use]pub fn finish(self) -> PagerMutex

Return a PagerMutex from this Pager. This is gated on tokio_lib or async_std_lib feature

Trait Implementations

impl Clone for Pager

pub fn clone(&self) -> Pager

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Pager

pub fn default() -> Self

Returns the "default value" for a type.