Struct PrettyPrinter

pub struct PrettyPrinter<'a> { /* private fields */ }

Implementations

impl<'a> PrettyPrinter<'a>

pub fn new() -> Self

pub fn input(&mut self, input: Input<'a>) -> &mut Self

Add an input which should be pretty-printed

pub fn inputs( &mut self, inputs: impl IntoIterator<Item = Input<'a>>, ) -> &mut Self

Adds multiple inputs which should be pretty-printed

pub fn input_file(&mut self, path: impl AsRef<Path>) -> &mut Self

Add a file which should be pretty-printed

pub fn input_files<I, P>(&mut self, paths: I) -> &mut Self

where I: IntoIterator<Item = P>, P: AsRef<Path>,

Add multiple files which should be pretty-printed

pub fn input_stdin(&mut self) -> &mut Self

Add STDIN as an input

pub fn input_from_bytes(&mut self, content: &'a [u8]) -> &mut Self

Add a byte string as an input

pub fn input_from_reader<R: Read + 'a>(&mut self, reader: R) -> &mut Self

Add a custom reader as an input

pub fn language(&mut self, language: &'a str) -> &mut Self

Specify the syntax file which should be used (default: auto-detect)

pub fn term_width(&mut self, width: usize) -> &mut Self

The character width of the terminal (default: autodetect)

pub fn tab_width(&mut self, tab_width: Option<usize>) -> &mut Self

The width of tab characters (default: None - do not turn tabs to spaces)

pub fn colored_output(&mut self, yes: bool) -> &mut Self

Whether or not the output should be colorized (default: true)

pub fn true_color(&mut self, yes: bool) -> &mut Self

Whether or not to output 24bit colors (default: true)

pub fn header(&mut self, yes: bool) -> &mut Self

Whether to show a header with the file name

pub fn line_numbers(&mut self, yes: bool) -> &mut Self

Whether to show line numbers

pub fn grid(&mut self, yes: bool) -> &mut Self

Whether to paint a grid, separating line numbers, git changes and the code

pub fn rule(&mut self, yes: bool) -> &mut Self

Whether to paint a horizontal rule to delimit files

pub fn vcs_modification_markers(&mut self, yes: bool) -> &mut Self

Whether to show modification markers for VCS changes. This has no effect if the git feature is not activated.

pub fn show_nonprintable(&mut self, yes: bool) -> &mut Self

Whether to print binary content or nonprintable characters (default: no)

pub fn snip(&mut self, yes: bool) -> &mut Self

Whether to show “snip” markers between visible line ranges (default: no)

pub fn strip_ansi(&mut self, mode: StripAnsiMode) -> &mut Self

Whether to remove ANSI escape sequences from the input (default: never)

If Auto is used, escape sequences will only be removed when the input is not plain text.

pub fn wrapping_mode(&mut self, mode: WrappingMode) -> &mut Self

Text wrapping mode (default: do not wrap)

pub fn use_italics(&mut self, yes: bool) -> &mut Self

Whether or not to use ANSI italics (default: off)

pub fn paging_mode(&mut self, mode: PagingMode) -> &mut Self

If and how to use a pager (default: no paging)

pub fn pager(&mut self, cmd: &'a str) -> &mut Self

Specify the command to start the pager (default: use “less”)

pub fn line_ranges(&mut self, ranges: LineRanges) -> &mut Self

Specify the lines that should be printed (default: all)

pub fn highlight(&mut self, line: usize) -> &mut Self

Specify a line that should be highlighted (default: none). This can be called multiple times to highlight more than one line. See also: highlight_range.

pub fn highlight_range(&mut self, from: usize, to: usize) -> &mut Self

Specify a range of lines that should be highlighted (default: none). This can be called multiple times to highlight more than one range of lines.

pub fn squeeze_empty_lines(&mut self, maximum: Option<usize>) -> &mut Self

Specify the maximum number of consecutive empty lines to print.

pub fn theme(&mut self, theme: impl AsRef<str>) -> &mut Self

Specify the highlighting theme. You can use crate::theme::theme to pick a theme based on user preferences and the terminal’s background color.

pub fn syntax_mapping(&mut self, mapping: SyntaxMapping<'a>) -> &mut Self

Specify custom file extension / file name to syntax mappings

pub fn themes(&self) -> impl Iterator<Item = &str>

pub fn syntaxes(&self) -> impl Iterator<Item = Syntax> + '_

pub fn print(&mut self) -> Result<bool>

Pretty-print all specified inputs. This method will “use” all stored inputs. If you want to call ‘print’ multiple times, you have to call the appropriate input_* methods again.

pub fn print_with_writer<W: Write>(&mut self, writer: Option<W>) -> Result<bool>

Pretty-print all specified inputs to a specified writer.

Trait Implementations

impl Default for PrettyPrinter<'_>

fn default() -> Self

Returns the “default value” for a type.