update some documentation and move code around
cargo devel CI / cargo CI (push) Successful in 1m28s Details

This commit is contained in:
Christoph J. Scherr 2024-02-01 23:21:01 +01:00
parent e829027eb5
commit 7bea6ede4c
Signed by: PlexSheep
GPG Key ID: 7CDD0B14851A08EF
2 changed files with 36 additions and 27 deletions

View File

@ -1,9 +1,4 @@
//! # Dump data //! # Underlying mechanisms of how hedu works with data
//!
//! This crate is part of [`pt`](../libpt/index.html), but can also be used as a standalone
//! module.
//!
//! Hedu is made for hexdumping data. `libpt` offers a cli application using this module.
use std::io::{prelude::*, Read, SeekFrom}; use std::io::{prelude::*, Read, SeekFrom};
@ -16,6 +11,23 @@ pub const LINE_SEP_HORIZ: char = '─';
pub const LINE_SEP_VERT: char = '│'; pub const LINE_SEP_VERT: char = '│';
pub const CHAR_BORDER: &'static str = "|"; pub const CHAR_BORDER: &'static str = "|";
pub trait DataSource: Read {
fn skip(&mut self, length: usize) -> std::io::Result<()>;
}
impl DataSource for std::io::Stdin {
fn skip(&mut self, _length: usize) -> std::io::Result<()> {
warn!("can't skip bytes for the stdin!");
Ok(())
}
}
impl DataSource for std::fs::File {
fn skip(&mut self, length: usize) -> std::io::Result<()> {
self.seek(SeekFrom::Current(length as i64))?;
// returns the new position from the start, we don't need it here.
Ok(())
}
}
#[derive(Debug)] #[derive(Debug)]
pub struct Hedu { pub struct Hedu {
pub chars: bool, pub chars: bool,
@ -33,6 +45,7 @@ pub struct Hedu {
} }
impl Hedu { impl Hedu {
/// create a new hedu struct, initializing all kinds of configs and values needed while running
pub fn new(chars: bool, skip: usize, show_identical: bool, limit: usize) -> Self { pub fn new(chars: bool, skip: usize, show_identical: bool, limit: usize) -> Self {
Hedu { Hedu {
chars, chars,
@ -49,11 +62,15 @@ impl Hedu {
first_iter: true, first_iter: true,
} }
} }
/// print the display buffer to the stdout
#[inline] #[inline]
pub fn display(&mut self) { pub fn display(&mut self) {
println!("{}", self.display_buf); println!("{}", self.display_buf);
self.display_buf = String::new(); self.display_buf = String::new();
} }
/// display a separator line
#[inline] #[inline]
pub fn sep(&mut self) { pub fn sep(&mut self) {
if self.chars { if self.chars {
@ -63,11 +80,15 @@ impl Hedu {
} }
self.display(); self.display();
} }
/// display a newline
#[inline] #[inline]
pub fn newline(&mut self) { pub fn newline(&mut self) {
self.display_buf += "\n"; self.display_buf += "\n";
self.display(); self.display();
} }
/// display the dump of a single line of data
fn dump_a_line(&mut self) { fn dump_a_line(&mut self) {
self.display_buf += &format!("{:08X} {LINE_SEP_VERT} ", self.data_idx); self.display_buf += &format!("{:08X} {LINE_SEP_VERT} ", self.data_idx);
if self.len != 0 { if self.len != 0 {
@ -105,6 +126,7 @@ impl Hedu {
self.display(); self.display();
} }
/// skip duplicate lines and display skip info
fn skip_lines(&mut self, data: &mut dyn DataSource) -> Result<()> { fn skip_lines(&mut self, data: &mut dyn DataSource) -> Result<()> {
trace!(buf = format!("{:?}", self.buf), "found a duplicating line"); trace!(buf = format!("{:?}", self.buf), "found a duplicating line");
let start_line = self.data_idx; let start_line = self.data_idx;
@ -128,6 +150,8 @@ impl Hedu {
self.display(); self.display();
Ok(()) Ok(())
} }
/// dump a data sources contents according to the set configs
pub fn dump(&mut self, data: &mut dyn DataSource) -> Result<()> { pub fn dump(&mut self, data: &mut dyn DataSource) -> Result<()> {
// skip a given number of bytes // skip a given number of bytes
if self.skip > 0 { if self.skip > 0 {
@ -188,6 +212,7 @@ impl Hedu {
self.data_idx += self.len; self.data_idx += self.len;
} }
/// read data from the data source
fn rd_data(&mut self, data: &mut dyn DataSource) -> Result<()> { fn rd_data(&mut self, data: &mut dyn DataSource) -> Result<()> {
match data.read(&mut self.buf[self.alt_buf]) { match data.read(&mut self.buf[self.alt_buf]) {
Ok(mut len) => { Ok(mut len) => {
@ -197,33 +222,17 @@ impl Hedu {
} }
self.len = len; self.len = len;
self.adjust_counters(); self.adjust_counters();
return Ok(()); Ok(())
} }
Err(err) => { Err(err) => {
error!("error while reading data: {err}"); error!("error while reading data: {err}");
bail!(err) Err(err.into())
} }
} }
} }
} }
pub trait DataSource: Read { /// interpret characters for the --chars option
fn skip(&mut self, length: usize) -> std::io::Result<()>;
}
impl DataSource for std::io::Stdin {
fn skip(&mut self, _length: usize) -> std::io::Result<()> {
warn!("can't skip bytes for the stdin!");
Ok(())
}
}
impl DataSource for std::fs::File {
fn skip(&mut self, length: usize) -> std::io::Result<()> {
self.seek(SeekFrom::Current(length as i64))?;
// returns the new position from the start, we don't need it here.
Ok(())
}
}
fn mask_chars(c: char) -> char { fn mask_chars(c: char) -> char {
if c.is_ascii_graphic() { if c.is_ascii_graphic() {
return c; return c;

View File

@ -1,6 +1,6 @@
//! # Executable for the hedu submodule //! # A simple hexdumper with a somewhat fancy format
//! //!
//! Dump data to a fancy format. //! Dump data from any readable source, such as the stdin or a file
#![warn(clippy::pedantic)] #![warn(clippy::pedantic)]
use std::{fs::File, io::IsTerminal, path::PathBuf}; use std::{fs::File, io::IsTerminal, path::PathBuf};