Struct Printer

pub struct Printer { /* private fields */ }

Maintains an internal state describing how to display a byte array.

It can write to an arbitrary std::fmt::Write implementation using the method Printer::write_to.

Implementations

impl Printer

pub fn new(quote_style: QuoteStyle) -> Self

Returns a new Printer with the chosen quoting style.

pub fn write_to<I, W>(&self, bytes: I, writer: &mut W) -> Result

where I: IntoIterator, I::Item: Borrow<u8>, W: Write,

Writes the formatted bytes to an arbitrary std::fmt::Write implementation.

This method iterates through the byte array and calls writer.write_char or writer.write_str as appropriate. The performance of this method thus depends on the implementation of the underlying writer. If a writer doesn’t implement good buffering, or if each call to write makes a system call to do IO, this can be inefficient.

The helper method Printer::into_string is a thin wrapper around this method, calling write_to with a String as its writer. String implements fmt::Write with methods like String::push and String::push_str, which should be adequately performant for most uses. If the use case calls for it, the user can always implement their own writer with custom buffering.

pub fn into_string<I>(&self, bytes: I) -> String

where I: IntoIterator, I::Item: Borrow<u8>,

Returns a string displaying the bytes.

Trait Implementations

impl Clone for Printer

fn clone(&self) -> Printer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Printer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Printer

Returns a printer that doesn’t quote its output.

This is equivalent to Printer::new(QuoteStyle::None).

fn default() -> Self

Returns the “default value” for a type.

impl Hash for Printer

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Printer

fn cmp(&self, other: &Printer) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Printer

fn eq(&self, other: &Printer) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Printer

fn partial_cmp(&self, other: &Printer) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Printer

impl Eq for Printer

impl StructuralPartialEq for Printer