Struct sequoia_openpgp::fmt::hex::Dumper

pub struct Dumper<W: Write> { /* private fields */ }

Writes annotated hex dumps, like hd(1).

Examples

use sequoia_openpgp::fmt::hex;

let mut dumper = hex::Dumper::new(Vec::new(), "");
dumper.write(&[0x89, 0x01, 0x33], "frame")?;
dumper.write(&[0x04], "version")?;
dumper.write(&[0x00], "type")?;

let buf = dumper.into_inner();
assert_eq!(
    ::std::str::from_utf8(&buf[..])?,
    "00000000  89 01 33                                           frame\n\
     00000003           04                                        version\n\
     00000004              00                                     type\n\
     ");

Implementations

impl<W: Write> Dumper<W>

pub fn new<I: AsRef<str>>(inner: W, indent: I) -> Self

Creates a new dumper.

The dump is written to inner. Every line is indented with indent.

pub fn with_offset<I>(inner: W, indent: I, offset: usize) -> Self where
    I: AsRef<str>, 

Creates a new dumper starting at the given offset.

The dump is written to inner. Every line is indented with indent.

pub fn into_inner(self) -> W

Returns the inner writer.

pub fn write<B, M>(&mut self, buf: B, msg: M) -> Result<()> where
    B: AsRef<[u8]>,
    M: AsRef<str>, 

Writes a chunk of data.

The msg is printed at the end of the first line.

pub fn write_ascii<B>(&mut self, buf: B) -> Result<()> where
    B: AsRef<[u8]>, 

Writes a chunk of data with ASCII-representation.

This produces output similar to hd(1).

pub fn write_labeled<B, L>(&mut self, buf: B, labeler: L) -> Result<()> where
    B: AsRef<[u8]>,
    L: FnMut(usize, &[u8]) -> Option<String>, 

Writes a chunk of data.

For each line, the given function is called to compute a label that printed at the end of the first line. The functions first argument is the offset in the current line (0..16), the second the slice of the displayed data.