Struct dangerous::display::InputDisplay

pub struct InputDisplay<'i> { /* fields omitted */ }

Provides configurable Input formatting.

• Defaults to formatting an Input to a max displayable width of 1024.
• The minimum settable display width is 16.

Format string options

Option	"heya ♥"	&[0xFF, 0xFF, 0xFF, 0xFF, 0xFF b'a']
"{}"	[68 65 79 61 20 e2 99 a5]	[ff ff ff ff ff 61]
"{:#}"	"heya ♥"	[ff ff ff ff ff 'a']
"{:.16}"	[68 65 .. 99 a5]	[ff ff .. ff 61]
"{:#.16}"	"heya ♥"	[ff ff .. 'a']

Example

let formatted = dangerous::input("heya ♥".as_bytes())
    .display()
    .head_tail(16)
    .to_string();
assert_eq!(formatted, "[68 65 .. 99 a5]");

Implementations

impl<'i> InputDisplay<'i>

pub const fn new(input: &'i Input) -> Self

Create a new InputDisplay given Input.

pub fn from_formatter(input: &'i Input, f: &Formatter<'_>) -> Self

Derive an InputDisplay from a fmt::Formatter with defaults.

• Precision (eg. {:.16}) formatting sets the element limit.
• Alternate/pretty (eg. {:#}) formatting enables the UTF-8 hint.

pub fn underline(self, value: bool) -> Self

Print the input underline for any provided span.

pub fn str_hint(self, value: bool) -> Self

Hint to the formatter that the Input is a UTF-8 str.

pub fn format(self, format: PreferredFormat) -> Self

Set the preferred way to format the Input.

pub fn head_tail(self, width: usize) -> Self

Show a width of Input at the head of the input and at the tail.

Example

let input = dangerous::input(&[0xAA, 0xBB, 0xCC, 0xDD, 0xEE, 0xFF]);
let formatted = input.display().head_tail(16).to_string();

assert_eq!(formatted, "[aa bb .. ee ff]");

pub fn head(self, width: usize) -> Self

Show a width of Input at the head of the input.

Example

let input = dangerous::input(&[0xAA, 0xBB, 0xCC, 0xDD, 0xEE, 0xFF]);
let formatted = input.display().head(16).to_string();

assert_eq!(formatted, "[aa bb cc dd ..]");

pub fn tail(self, width: usize) -> Self

Show a width of Input at the tail of the input.

Example

let input = dangerous::input(&[0xAA, 0xBB, 0xCC, 0xDD, 0xEE, 0xFF]);
let formatted = input.display().tail(16).to_string();

assert_eq!(formatted, "[.. cc dd ee ff]");

pub fn span(self, span: &'i Input, width: usize) -> Self

Show a width of input Input targeting a span.

Example

let full = &[0xAA, 0xBB, 0xCC, 0xDD, 0xEE, 0xFF];
let input = dangerous::input(full);
let span = dangerous::input(&full[5..]);
let formatted = input.display().span(span, 16).to_string();

assert_eq!(formatted, "[.. cc dd ee ff]");

pub fn full(self) -> Self

Shows the all of the elements in the Input.

Example

let input = dangerous::input(&[0xAA, 0xBB, 0xCC, 0xDD, 0xEE, 0xFF]);
let formatted = input.display().full().to_string();

assert_eq!(formatted, "[aa bb cc dd ee ff]");

pub fn prepare(&mut self)

Compute the sections of input to display.

pub fn write<W>(&self, w: W) -> Result where
    W: Write, 

Writes the Input to a writer with the chosen format.

Errors

Returns core::fmt::Error if failed to write.

Trait Implementations

impl<'i> Clone for InputDisplay<'i>

fn clone(&self) -> InputDisplay<'i>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'i> Debug for InputDisplay<'i>

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

Formats the value using the given formatter.

impl<'i> Display for InputDisplay<'i>

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

Formats the value using the given formatter.