Struct display_bytes::DisplayBytesConfig

pub struct DisplayBytesConfig<'d, F> { /* fields omitted */ }

Configuration builder for DisplayBytes.

Consts with sane defaults are provided in this module.

Methods

impl<'d, F> DisplayBytesConfig<'d, F>

pub fn byte_format<F_: ByteFormat>(
    self,
    format: F_
) -> DisplayBytesConfig<'d, F_>

Set the type used to format byte sequences.

pub fn byte_format_mut(&mut self) -> &mut F

Get a mutable reference to the current ByteFormat.

pub fn delimiters<'d_>(
    self,
    delimiters: [&'d_ str; 2]
) -> DisplayBytesConfig<'d_, F>

Set the pair of delimiters used to wrap byte sequences in the formatted stream.

Note that this can change the lifetime bound.

pub fn delimiters_mut(&mut self) -> &mut [&'d str; 2]

Get a mutable reference to the current pair of delimiters.

pub fn ascii_only(self, ascii_only: bool) -> Self

If set to true, only displays ASCII byte sequences (bytes in [0x00, 0x7F]).

Otherwise, displays all valid UTF-8 sequences at least min_str_len bytes long.

pub fn min_str_len(self, min_str_len: usize) -> Self

The minimum number of bytes in length that a valid string sequence must be to be displayed.

Strings shorter than this length will be included in the nearest byte sequence. Use this to avoid extra noise from random decodable characters splitting byte sequences.

Note

This does not affect byte sequences that can be completely decoded. If print_terminators is set, this also will not affect strings at the beginning or at the end of the byte slice (e.g. valid strings at the start and end will be printed regardless of length).

pub fn print_terminators(self, print_terminators: bool) -> Self

If set to true, valid strings at the start and end of a byte slice will be printed regardless of their length relative to min_str_len.

pub fn escape_control(self, escape_ctl: bool) -> Self

If set to true, control characters will be printed in their escaped form (\n) instead of printed directly.

pub fn invert_delimiters(self, invert_delimiters: bool) -> Self

If set to true, wraps decoded strings in the given delimiters rather than byte sequences.

impl<'d, F: ByteFormat> DisplayBytesConfig<'d, F>

pub fn display_bytes_string<'b>(&self, bytes: &'b [u8]) -> Cow<'b, str> where
    'd: 'b,
    F: 'b, 

Attempt to convert bytes to a string (an ASCII-only string if ascii_only is set, UTF-8 otherwise), or otherwise format bytes to a string using the properties in this configuration.

pub fn ref_display_bytes<'b>(&'b self, bytes: &'b [u8]) -> DisplayBytes<'b, F>

Get a type that implements Display which will format bytes to an output stream using the properties in this configuration.

impl<'d, F: ByteFormat> DisplayBytesConfig<'d, F>

pub fn display_bytes<'b>(self, bytes: &'b [u8]) -> DisplayBytes<'b, F> where
    'd: 'b, 

Get a type that implements Display which will format bytes to an output stream using the properties in this configuration.

Trait Implementations

impl Default for DisplayBytesConfig<'static, FormatHex<'static>>

fn default() -> Self

Returns the "default value" for a type.

impl Default for DisplayBytesConfig<'static, FormatBase64>

fn default() -> Self

Returns the "default value" for a type.

impl<'d, F: Clone> Clone for DisplayBytesConfig<'d, F>

fn clone(&self) -> DisplayBytesConfig<'d, F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'d, F: Debug> Debug for DisplayBytesConfig<'d, F>

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

Formats the value using the given formatter.