Struct streampager::pager::Pager

pub struct Pager { /* private fields */ }

The main pager state.

Implementations

impl Pager

pub fn new_using_system_terminal() -> Result<Self>

Build a Pager using the system terminal.

pub fn new_using_stdio() -> Result<Self>

Build a Pager using the system stdio.

pub fn new_with_input_output(
    input: &impl AsRawFd,
    output: &impl AsRawFd
) -> Result<Self>

Build a Pager using the specified terminal input and output.

pub fn add_stream(
    &mut self,
    stream: impl Read + Send + 'static,
    title: &str
) -> Result<FileIndex>

Add a stream to be paged.

pub fn add_error_stream(
    &mut self,
    stream: impl Read + Send + 'static,
    title: &str
) -> Result<FileIndex>

Attach an error stream to the previously added output stream.

pub fn add_file(&mut self, filename: &OsStr) -> Result<FileIndex>

Attach a file from disk.

pub fn add_controlled_file(
    &mut self,
    controller: &Controller
) -> Result<FileIndex>

Attach a controlled file.

pub fn add_subprocess<I, S>(
    &mut self,
    command: &OsStr,
    args: I,
    title: &str
) -> Result<(FileIndex, FileIndex)>where
    I: IntoIterator<Item = S>,
    S: AsRef<OsStr>,

Attach the output and error streams from a subprocess.

Returns the file index for each stream.

pub fn set_progress_stream(&mut self, stream: impl Read + Send + 'static)

Set the progress stream.

pub fn set_interface_mode(&mut self, value: impl Into<InterfaceMode>)

Set when to use full screen mode. See InterfaceMode for details.

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

Set whether scrolling can past end of file.

pub fn set_read_ahead_lines(&mut self, lines: usize)

Set how many lines to read ahead.

pub fn set_startup_poll_input(&mut self, poll_input: bool)

Set whether to poll input during start-up (delayed or direct mode).

pub fn set_show_ruler(&mut self, show_ruler: bool)

Set whether to show the ruler by default.

pub fn set_wrapping_mode(&mut self, value: impl Into<WrappingMode>)

Set default wrapping mode. See WrappingMode for details.

pub fn set_keymap_name(&mut self, keymap: impl Into<String>)

Set keymap name.

pub fn set_keymap(&mut self, keymap: Keymap)

Set keymap.

pub fn action_sender(&self) -> ActionSender

Create an action sender which can be used to send Actions to this pager.

pub fn run(self) -> Result<()>

Run Stream Pager.