Provide examples

[sharkdp]

Provide examples

[sharkdp]

but I couldn't find an example of how to use this as a library.

Because, so far, nobody volunteered to write the documentation. Note that hexyl was only recently turned into a library crate (#68). I never really designed it to be a library as well.

I imagine it should be pretty simple

Here you go:

hexyl/examples/simple.rs

Lines 1 to 20 in abc7939

	use std::io;
	use hexyl::{BorderStyle, Printer};
	fn main() {
	let input = vec![
	0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a, 0x00, 0x00, 0x00, 0x0d, 0x49, 0x48, 0x44,
	0x52, 0x00, 0x00, 0x00, 0x80, 0x00, 0x00, 0x00, 0x44, 0x08, 0x02, 0x00, 0x00, 0x00,
	];
	let stdout = io::stdout();
	let mut handle = stdout.lock();
	let show_color = true;
	let use_squeezing = false;
	let border_style = BorderStyle::Unicode;
	let mut printer = Printer::new(&mut handle, show_color, border_style, use_squeezing);
	printer.print_all(&input[..], None).unwrap();
	}

but now I realize this can't be done since Printer doesn't allow you to specify a custom writer like Display expects.

Why not? Printer::new takes a &'a mut Writer with Writer: Write (i.e. it takes a &mut impl Write). When implementing Display::fmt, you have access to a Formatter, which itself implements Write.

[sharkdp]

Thank you for the update!

IIRC it was around the differences between core::fmt::Write and std::io::Write where Printer takes a different Writer than fmt::Display expects.

Oh - you are right. Printer takes a std::io::Write. Formatter implements std::fmt::Write. I had never noticed that there are two versions of this.

If you come back to your project at some point and think that there is something that we can do here, please let us know.

[lovesegfault]

On a secondary note, I was hoping to use hexyl as my Display implementation, but now I realize this can't be done since Printer doesn't allow you to specify a custom writer like Display expects.

[sharkdp]

Some kind of reaction/response would have been nice :-/

[lovesegfault]

Hi @sharkdp, I'm really sorry for not having gotten back to you, this escaped me in the GH notification chaos.

Thanks a lot for adding the lib usage example! Regarding the issues with implementing Display, I haven't touched the project I was working on in a while, but IIRC it was around the differences between core::fmt::Write and std::io::Write where Printer takes a different Writer than fmt::Display expects. You can write an adapter, but it's ugly.

c.f. https://github.com/lovesegfault/chirp/blob/master/src/memory.rs#L31-L43