Struct Pager

pub struct Pager { /* private fields */ }

Keeps track of the current pager state

Implementations

impl Pager

pub fn new() -> Self

Creates new instance of Pager with default settings

pub fn with_env(env: &str) -> Self

Creates new instance of pager using env environment variable instead of PAGER

pub fn env(env: &str) -> Self

👎Deprecated since 0.12.0: use with_env() instead

pub fn with_default_pager<S>(pager: S) -> Self

where S: Into<OsString>,

Creates a new Pager instance with the specified default fallback

pub fn with_pager(pager: &str) -> Self

Creates a new Pager instance directly specifying the desired pager

pub fn pager_envs( self, envs: impl IntoIterator<Item = impl Into<OsString>>, ) -> Self

Launch pager with the specified environment variables

pub fn skip_on_notty(self) -> Self

👎Deprecated since 0.14.0: ‘skip_on_notty’ is default now

Instructs Pager to bypass invoking pager if output is not a tty

pub fn is_on(&self) -> bool

Gives quick assessment of successful Pager setup

pub fn setup(&mut self)

Initiates Pager framework and sets up all the necessary environment for sending standard output to the activated pager.

Trait Implementations

impl Debug for Pager

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

Formats the value using the given formatter.

impl Default for Pager

fn default() -> Self

Returns the “default value” for a type.