Struct minus::Pager

pub struct Pager { /* fields omitted */ }

A struct containing all configurations for the pager.

This is used by all initializing functions

Implementations

impl Pager

pub fn new() -> Result<Self, TermError>

Initialize a new pager configuration

Errors

This function will return an error if it cannot determine the terminal size

Example

let pager = minus::Pager::new().unwrap();

pub fn set_text(&mut self, text: impl Into<String>)

Set the output text to this t

Note that unlike Pager::push_str, this replaces the original text. If you want to append text, use the Pager::push_str function

Example

let mut pager = minus::Pager::new().unwrap();
pager.set_text("This is a line");

pub fn set_line_numbers(&mut self, l: LineNumbers)

Set line number to this setting

Example

use minus::{Pager, LineNumbers};

let mut pager = Pager::new().unwrap();
pager.set_line_numbers(LineNumbers::Enabled);

pub fn send_message(&mut self, text: impl Into<String>)

Display a temporary message at the prompt area

Panics

This function panics if the given text contains newline characters. This is because, the pager reserves only one line for showing the prompt and a newline will cause it to span multiple lines, breaking the display

Example

use minus::Pager;

let mut pager = Pager::new().unwrap();
pager.send_message("An error occurred");

pub fn set_prompt(&mut self, t: impl Into<String>)

Set the prompt displayed at the prompt to t

Panics

This function panics if the given text contains newline characters. This is because, the pager reserves only one line for showing the prompt and a newline will cause it to span multiple lines, breaking the display

Example

use minus::Pager;

let mut pager = Pager::new().unwrap();
pager.set_prompt("my awesome program");

pub fn finish(self) -> PagerMutex

This is supported on crate features tokio_lib or async_std_lib only.

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

Example

use minus::Pager;

let mut pager = Pager::new().unwrap();
pager.set_text("This output is paged");
let _pager_mutex = pager.finish();

pub fn set_exit_strategy(&mut self, strategy: ExitStrategy)

Set the default exit strategy.

This controls how the pager will behave when the user presses q or Ctrl+C. See ExitStrategy for available options

use minus::{Pager, ExitStrategy};

let mut pager = Pager::new().unwrap();
pager.set_exit_strategy(ExitStrategy::ProcessQuit);

pub fn set_run_no_overflow(&mut self, value: bool)

Set whether to display pager if there’s less data than available screen height

By default this is set to false

use minus::Pager;

let mut pager = Pager::new().unwrap();
pager.set_run_no_overflow(true);

pub fn push_str(&mut self, string: impl Into<String>)

Appends text to the pager output

This function will automatically split the lines, if they overflow the number of terminal columns

let mut pager = minus::Pager::new().unwrap();
pager.push_str("This is some text");

pub fn end_data_stream(&mut self)

Hints the running pager that no more data is coming

Example

use minus::Pager;

let mut pager = Pager::new().unwrap();
pager.set_text("Hello from minus!");
pager.end_data_stream();

pub fn set_input_handler(
    &mut self,
    handler: Box<dyn InputClassifier + Send + Sync>
)

Set custom input handler function

See example in InputHandler on using this function

pub fn add_exit_callback(&mut self, cb: impl FnMut() + Send + Sync + 'static)

Example

use minus::Pager;

fn hello() {
    println!("Hello");
}

let mut pager = Pager::new().unwrap();
pager.add_exit_callback(Box::new(hello));

Trait Implementations

impl Default for Pager

fn default() -> Self

Returns the “default value” for a type.

impl Write for Pager

fn write_str(&mut self, string: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.