Enum oma_console::pager::Pager

source ·
pub enum Pager {
    Plain,
    External((String, Child)),
}

Variants§

§

Plain

§

External((String, Child))

Implementations§

source§

impl Pager

source

pub fn new(no_pager: bool, tips: &str) -> OmaConsoleResult<Self>

Create a new Pager (less or less-like Pager) no_pager: if false, not use less-like to see file tips: less tips

Examples found in repository?
examples/pager.rs (line 4)
3
4
5
6
7
8
9
10
11
12
13
fn main() -> Result<(), OmaConsoleError> {
    let mut p = Pager::new(false, "Press [q] to end review, [Ctrl-c] to abort, [PgUp/Dn], arrow keys, or mouse wheel to scroll.")?;
    let mut w = p.get_writer()?;
    w.write_all(b"QAQ\n").ok();
    w.write_all(b"PAP").ok();

    drop(w);
    p.wait_for_exit()?;

    Ok(())
}
source

pub fn pager_name(&self) -> Option<&str>

Get pager name (like less)

source

pub fn get_writer(&self) -> OmaConsoleResult<Box<dyn Write + '_>>

Get writer to writer something to pager

Examples found in repository?
examples/pager.rs (line 5)
3
4
5
6
7
8
9
10
11
12
13
fn main() -> Result<(), OmaConsoleError> {
    let mut p = Pager::new(false, "Press [q] to end review, [Ctrl-c] to abort, [PgUp/Dn], arrow keys, or mouse wheel to scroll.")?;
    let mut w = p.get_writer()?;
    w.write_all(b"QAQ\n").ok();
    w.write_all(b"PAP").ok();

    drop(w);
    p.wait_for_exit()?;

    Ok(())
}
source

pub fn wait_for_exit(&mut self) -> OmaConsoleResult<bool>

Wait pager to exit

Examples found in repository?
examples/pager.rs (line 10)
3
4
5
6
7
8
9
10
11
12
13
fn main() -> Result<(), OmaConsoleError> {
    let mut p = Pager::new(false, "Press [q] to end review, [Ctrl-c] to abort, [PgUp/Dn], arrow keys, or mouse wheel to scroll.")?;
    let mut w = p.get_writer()?;
    w.write_all(b"QAQ\n").ok();
    w.write_all(b"PAP").ok();

    drop(w);
    p.wait_for_exit()?;

    Ok(())
}

Trait Implementations§

source§

impl Drop for Pager

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl RefUnwindSafe for Pager

§

impl Send for Pager

§

impl Sync for Pager

§

impl Unpin for Pager

§

impl UnwindSafe for Pager

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.