Class: Pry::Pager

A pager is an `IO`-like object that accepts text and either prints it immediately, prints it one page at a time, or streams it to an external program to print one page at a time.

Methods

new open page

Classes and Modules

Class Pry::Pager::NullPager
Class Pry::Pager::PageTracker
Class Pry::Pager::SimplePager
Class Pry::Pager::StopPaging
Class Pry::Pager::SystemPager

Attributes

_pry_ [R]

Public Class methods

new(_pry_)

Public Instance methods

open() {|pager| ...}

Yields a pager object (`NullPager`, `SimplePager`, or `SystemPager`). All pagers accept output with `puts`, `print`, `write`, and `#<<`. @param [IO] output (`$stdout`) An object to send output to.

page(text)

Send the given text through the best available pager (if `Pry.config.pager` is enabled). If you want to send text through in chunks as you generate it, use `open` to get a writable object instead. @param [String] text A piece of text to run through a pager. @param [IO] output (`$stdout`) An object to send output to.