Struct prettyprint::PrettyPrinter

pub struct PrettyPrinter { /* fields omitted */ }

Builder for PrettyPrint.

Methods

impl PrettyPrinter

pub fn language<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Language for syntax highlighting

pub fn show_nonprintable<VALUE: Into<bool>>(
    &mut self,
    value: VALUE
) -> &mut Self

Whether or not to show/replace non-printable characters like space, tab and newline.

pub fn term_width<VALUE: Into<usize>>(&mut self, value: VALUE) -> &mut Self

The character width of the terminal

pub fn tab_width<VALUE: Into<usize>>(&mut self, value: VALUE) -> &mut Self

The width of tab characters. Currently, a value of 0 will cause tabs to be passed through without expanding them.

pub fn loop_through<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Whether or not to simply loop through all input (cat mode)

pub fn colored_output<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Whether or not the output should be colorized

pub fn true_color<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Whether or not the output terminal supports true color

pub fn grid<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Print grid

pub fn header<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Print header with output file name

pub fn line_numbers<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Print line numbers

pub fn output_wrap<VALUE: Into<OutputWrap>>(
    &mut self,
    value: VALUE
) -> &mut Self

Text wrapping mode

pub fn paging_mode<VALUE: Into<PagingMode>>(
    &mut self,
    value: VALUE
) -> &mut Self

Pager or STDOUT

pub fn line_ranges<VALUE: Into<LineRanges>>(
    &mut self,
    value: VALUE
) -> &mut Self

Specifies the lines that should be printed

pub fn theme<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

The syntax highlighting theme

pub fn syntax_mapping<VALUE: Into<SyntaxMapping>>(
    &mut self,
    value: VALUE
) -> &mut Self

File extension/name mappings

pub fn load_syntax<VALUE: Into<Option<Vec<u8>>>>(
    &mut self,
    value: VALUE
) -> &mut Self

Load custom syntax-highlighter

pub fn load_theme<VALUE: Into<Option<Vec<u8>>>>(
    &mut self,
    value: VALUE
) -> &mut Self

Load custom theme library

pub fn pager<VALUE: Into<Option<String>>>(&mut self, value: VALUE) -> &mut Self

Command to start the pager

pub fn use_italic_text<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

Whether to print some characters using italics

pub fn build(&self) -> Result<PrettyPrint, String>

Builds a new PrettyPrint.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for PrettyPrinter

fn clone(&self) -> PrettyPrinter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for PrettyPrinter

fn default() -> PrettyPrinter

Returns the "default value" for a type.

impl<'_> From<&'_ PrettyPrint> for PrettyPrinter

fn from(printer: &PrettyPrint) -> Self

Performs the conversion.