PlexSheep
/
numf
Archived
generated from PlexSheep/rs-base
1
1
Fork 0
Code Issues 2 Pull Requests 1 Actions Packages Projects Releases 8 Wiki Activity

refactor: write in binary now
cargo devel CI / cargo CI (push) Successful in 1m32s Details 

Refs: #26
This commit is contained in:
Christoph J. Scherr 2024-09-06 11:27:18 +02:00
parent 23c653e9c0
commit e92af8acfa
Signed by: cscherrNT
GPG Key ID: 8E2B45BC51A27EA7
3 changed files with 148 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

111
src/format.rs
View File

@ -13,9 +13,12 @@
//! options.set_prefix(true); //! options.set_prefix(true);
//! options.set_padding(true); //! options.set_padding(true);
//! //!
//! assert_eq!(Format::Hex.format(0x1337, &options), "0x1337"); //! assert_eq!(Format::Hex.format_str(0x1337, &options), "0x1337");
//! assert_eq!(Format::Base32.format(0x41414242, &options), "032sIFAUEQQ="); //! assert_eq!(Format::Base32.format_str(0x41414242, &options), "032sIFAUEQQ=");
//! assert_eq!(Format::Base64.format(0x41414242, &options), "0sQUFCQg=="); //! assert_eq!(Format::Base64.format_str(0x41414242, &options), "0sQUFCQg==");
//! // sometimes you might need the raw bytes instead of a String
//! assert_eq!(Format::Raw.format(0x1337, &options), vec![0x13, 0x37]);
//! assert_eq!(Format::Hex.format(0x1337, &options), vec![48, 120, 49, 51, 51, 55]);
//! ``` //! ```
#![allow(dead_code)] // this is exported to lib.rs #![allow(dead_code)] // this is exported to lib.rs
@ -35,6 +38,8 @@ pub enum Format {
Octal, Octal,
Base64, Base64,
Base32, Base32,
/// Write raw data to stdout, not text
Raw,
} }
/// Describes what the formatter should do /// Describes what the formatter should do
@ -59,7 +64,7 @@ Author: {author-with-newline}
)] )]
#[clap(group( #[clap(group(
ArgGroup::new("format") ArgGroup::new("format")
.args(&["hex", "bin", "oct", "dec", "base64", "base32"]), .args(&["hex", "bin", "oct", "dec", "base64", "base32", "raw"]),
))] ))]
pub struct FormatOptions { pub struct FormatOptions {
#[arg(short, long)] #[arg(short, long)]
@ -86,6 +91,9 @@ pub struct FormatOptions {
#[arg(short = 's', long)] #[arg(short = 's', long)]
/// format to base64 /// format to base64
base64: bool, base64: bool,
#[arg(short = 'a', long)]
/// format raw, no text
raw: bool,
#[arg(short = 'r', long, default_value_t = 0, value_parser=numf_parser::<NumberType>)] #[arg(short = 'r', long, default_value_t = 0, value_parser=numf_parser::<NumberType>)]
/// output random numbers /// output random numbers
/// ///
@ -136,6 +144,8 @@ impl FormatOptions {
Format::Base32 Format::Base32
} else if self.hex { } else if self.hex {
Format::Hex Format::Hex
} else if self.raw {
Format::Raw
} else { } else {
unreachable!() unreachable!()
} }
@ -148,9 +158,11 @@ impl FormatOptions {
self.dec = false; self.dec = false;
self.hex = false; self.hex = false;
self.base64 = false; self.base64 = false;
self.raw = false;
self.base32 = false; self.base32 = false;
match format { match format {
Format::Bin => self.bin = true, Format::Bin => self.bin = true,
Format::Raw => self.raw = true,
Format::Hex => self.hex = true, Format::Hex => self.hex = true,
Format::Octal => self.oct = true, Format::Octal => self.oct = true,
Format::Base64 => self.base64 = true, Format::Base64 => self.base64 = true,
@ -223,6 +235,7 @@ impl Default for FormatOptions {
oct: false, oct: false,
hex: true, hex: true,
bin: false, bin: false,
raw: false,
base32: false, base32: false,
base64: false, base64: false,
dec: false, dec: false,
@ -234,52 +247,74 @@ impl Default for FormatOptions {
} }
impl Format { impl Format {
pub fn prefix_str(&self) -> String {
String::from_utf8_lossy(&self.prefix()).to_string()
}
/// Get the perfix for that [Format] /// Get the perfix for that [Format]
pub fn prefix(&self) -> String { pub fn prefix(&self) -> Vec<u8> {
match self { match self {
// apperently used nowhere, sometimes 0 is used as a prefix but I // apperently used nowhere, sometimes 0 is used as a prefix but I
// think this makes it more clear that this is decimal // think this makes it more clear that this is decimal
Format::Dec => "0d", Format::Dec => b"0d".to_vec(),
Format::Raw => [].to_vec(), // TODO: find a better way to deal with this
// very common // very common
Format::Hex => "0x", Format::Hex => b"0x".to_vec(),
// very common // very common
Format::Bin => "0b", Format::Bin => b"0b".to_vec(),
// somewhat common // somewhat common
Format::Octal => "0o", Format::Octal => b"0o".to_vec(),
// perl and a few other programs seem to use this too // perl and a few other programs seem to use this too
Format::Base64 => "0s", Format::Base64 => b"0s".to_vec(),
// no idea, I made this up // no idea, I made this up
Format::Base32 => "032s", Format::Base32 => b"032s".to_vec(),
} }
.to_string()
} }
/// format a number with a [Format] and [FormatOptions] to [String]
pub fn format_str(&self, num: NumberType, options: &FormatOptions) -> String {
String::from_utf8_lossy(&self.format(num, options)).to_string()
}
/// format a number with a [Format] and [FormatOptions] /// format a number with a [Format] and [FormatOptions]
pub fn format(&self, num: NumberType, options: &FormatOptions) -> String { pub fn format(&self, num: NumberType, options: &FormatOptions) -> Vec<u8> {
let mut buf = String::new(); let mut buf: Vec<u8> = Vec::new();
if options.prefix() { if options.prefix() {
buf += &self.prefix(); buf.append(&mut self.prefix());
} }
match self { match self {
Format::Hex => { Format::Hex => {
if options.padding() { if options.padding() {
let tmp = &format!("{num:X}"); let tmp = &format!("{num:X}");
buf += &("0".repeat((2 - tmp.len() % 2) % 2) + tmp); let tmp1 = &("0".repeat((2 - tmp.len() % 2) % 2) + tmp);
buf.append(&mut tmp1.as_bytes().to_owned());
} else { } else {
buf += &format!("{num:X}"); buf.append(&mut format!("{num:X}").as_bytes().to_owned());
} }
} }
Format::Bin => { Format::Bin => {
if options.padding() { if options.padding() {
let tmp = &format!("{num:b}"); let tmp = &format!("{num:b}");
buf += &("0".repeat((8 - tmp.len() % 8) % 8) + tmp); let tmp1 = &("0".repeat((8 - tmp.len() % 8) % 8) + tmp);
buf.append(&mut tmp1.as_bytes().to_owned());
} else { } else {
buf += &format!("{num:b}"); buf.append(&mut format!("{num:b}").as_bytes().to_owned());
} }
} }
Format::Octal => buf += &format!("{num:o}"), Format::Octal => buf.append(&mut format!("{num:o}").as_bytes().to_owned()),
Format::Dec => buf += &format!("{num}"), Format::Dec => buf.append(&mut format!("{num}").as_bytes().to_owned()),
Format::Base64 => buf += &fast32::base64::RFC4648.encode(&split::unsigned_to_vec(num)), Format::Base64 => buf.append(
Format::Base32 => buf += &fast32::base32::RFC4648.encode(&split::unsigned_to_vec(num)), &mut fast32::base64::RFC4648
.encode(&split::unsigned_to_vec(num))
.as_bytes()
.to_owned(),
),
Format::Base32 => buf.append(
&mut fast32::base32::RFC4648
.encode(&split::unsigned_to_vec(num))
.as_bytes()
.to_owned(),
),
Format::Raw => buf.append(&mut split::unsigned_to_vec(num)),
} }
buf buf
} }
@ -324,8 +359,8 @@ where
<T as std::convert::TryFrom<u128>>::Error: std::marker::Sync, <T as std::convert::TryFrom<u128>>::Error: std::marker::Sync,
<T as std::convert::TryFrom<u128>>::Error: 'static, <T as std::convert::TryFrom<u128>>::Error: 'static,
{ {
if s.starts_with(&Format::Dec.prefix()) || s.parse::<T>().is_ok() { if s.starts_with(&Format::Dec.prefix_str()) || s.parse::<T>().is_ok() {
let s = match s.strip_prefix(&Format::Dec.prefix()) { let s = match s.strip_prefix(&Format::Dec.prefix_str()) {
Some(sr) => sr, Some(sr) => sr,
None => s, None => s,
}; };
@ -336,8 +371,8 @@ where
Err(anyhow!(e)) Err(anyhow!(e))
} }
} }
} else if s.starts_with(&Format::Hex.prefix()) { } else if s.starts_with(&Format::Hex.prefix_str()) {
let s = match s.strip_prefix(&Format::Hex.prefix()) { let s = match s.strip_prefix(&Format::Hex.prefix_str()) {
Some(sr) => sr, Some(sr) => sr,
None => s, None => s,
}; };
@ -348,8 +383,8 @@ where
Err(anyhow!(e)) Err(anyhow!(e))
} }
} }
} else if s.starts_with(&Format::Octal.prefix()) { } else if s.starts_with(&Format::Octal.prefix_str()) {
let s = match s.strip_prefix(&Format::Octal.prefix()) { let s = match s.strip_prefix(&Format::Octal.prefix_str()) {
Some(sr) => sr, Some(sr) => sr,
None => s, None => s,
}; };
@ -360,8 +395,8 @@ where
Err(anyhow!(e)) Err(anyhow!(e))
} }
} }
} else if s.starts_with(&Format::Bin.prefix()) { } else if s.starts_with(&Format::Bin.prefix_str()) {
let s = match s.strip_prefix(&Format::Bin.prefix()) { let s = match s.strip_prefix(&Format::Bin.prefix_str()) {
Some(sr) => sr, Some(sr) => sr,
None => s, None => s,
}; };
@ -372,8 +407,8 @@ where
Err(anyhow!(e)) Err(anyhow!(e))
} }
} }
} else if s.starts_with(&Format::Base64.prefix()) { } else if s.starts_with(&Format::Base64.prefix_str()) {
let s = match s.strip_prefix(&Format::Base64.prefix()) { let s = match s.strip_prefix(&Format::Base64.prefix_str()) {
Some(sr) => sr, Some(sr) => sr,
None => s, None => s,
}; };
@ -384,8 +419,8 @@ where
Err(anyhow!(e)) Err(anyhow!(e))
} }
} }
} else if s.starts_with(&Format::Base32.prefix()) { } else if s.starts_with(&Format::Base32.prefix_str()) {
let s = match s.strip_prefix(&Format::Base32.prefix()) { let s = match s.strip_prefix(&Format::Base32.prefix_str()) {
Some(sr) => sr, Some(sr) => sr,
None => s, None => s,
}; };
@ -396,6 +431,12 @@ where
Err(anyhow!(e)) Err(anyhow!(e))
} }
} }
} else if s.starts_with(&Format::Raw.prefix_str()) {
let s = match s.strip_prefix(&Format::Raw.prefix_str()) {
Some(sr) => sr,
None => s,
};
todo!("reading raw not implemented")
} else { } else {
let e = "could not determine the format of the value".to_string(); let e = "could not determine the format of the value".to_string();
Err(anyhow!(e)) Err(anyhow!(e))

9
src/main.rs
View File

@ -1,4 +1,4 @@
use std::io::{IsTerminal, Read}; use std::io::{stdout, IsTerminal, Read, Write};
use std::process::exit; use std::process::exit;
use clap::{CommandFactory, Parser}; use clap::{CommandFactory, Parser};
@ -61,13 +61,16 @@ fn main() -> anyhow::Result<()> {
exit(1); exit(1);
} }
let mut out: Vec<String> = Vec::new(); let mut out: Vec<Vec<u8>> = Vec::new();
for num in options.numbers() { for num in options.numbers() {
out.push(options.format().format(*num, &options)); out.push(options.format().format(*num, &options));
} }
for o in out { for o in out {
println!("{o}") let mut stdout = std::io::stdout();
stdout.write_all(&o)?;
stdout.write_all(b"\n")?;
stdout.flush()?;
} }
Ok(()) Ok(())
} }

118
tests/format.rs
View File

@ -3,42 +3,42 @@ use numf::format::*;
#[test] #[test]
fn format() { fn format() {
let options = FormatOptions::default(); let options = FormatOptions::default();
assert_eq!(Format::Dec.format(1337, &options), "1337"); assert_eq!(Format::Dec.format_str(1337, &options), "1337");
assert_eq!( assert_eq!(
Format::Dec.format(u128::MAX, &options), Format::Dec.format_str(u128::MAX, &options),
format!("{}", u128::MAX) format!("{}", u128::MAX)
); );
assert_eq!(Format::Hex.format(0x1337, &options), "1337"); assert_eq!(Format::Hex.format_str(0x1337, &options), "1337");
assert_eq!( assert_eq!(
Format::Hex.format(u128::MAX, &options), Format::Hex.format_str(u128::MAX, &options),
format!("{:X}", u128::MAX) format!("{:X}", u128::MAX)
); );
assert_eq!( assert_eq!(
Format::Bin.format(0b1010001001010010010100111, &options), Format::Bin.format_str(0b1010001001010010010100111, &options),
"1010001001010010010100111" "1010001001010010010100111"
); );
assert_eq!( assert_eq!(
Format::Bin.format(u128::MAX, &options), Format::Bin.format_str(u128::MAX, &options),
format!("{:b}", u128::MAX) format!("{:b}", u128::MAX)
); );
assert_eq!(Format::Octal.format(0o13377331, &options), "13377331"); assert_eq!(Format::Octal.format_str(0o13377331, &options), "13377331");
assert_eq!( assert_eq!(
Format::Octal.format(u128::MAX, &options), Format::Octal.format_str(u128::MAX, &options),
format!("{:o}", u128::MAX) format!("{:o}", u128::MAX)
); );
assert_eq!(Format::Base32.format(0x41414242, &options), "IFAUEQQ="); assert_eq!(Format::Base32.format_str(0x41414242, &options), "IFAUEQQ=");
assert_eq!( assert_eq!(
Format::Base32.format(0x4141414141414141, &options), Format::Base32.format_str(0x4141414141414141, &options),
"IFAUCQKBIFAUC===" "IFAUCQKBIFAUC==="
); );
assert_eq!(Format::Base64.format(0x41414242, &options), "QUFCQg=="); assert_eq!(Format::Base64.format_str(0x41414242, &options), "QUFCQg==");
assert_eq!( assert_eq!(
Format::Base64.format(0x4141414141414141, &options), Format::Base64.format_str(0x4141414141414141, &options),
"QUFBQUFBQUE=" "QUFBQUFBQUE="
); );
} }
@ -48,47 +48,47 @@ fn format_padding() {
let mut options = FormatOptions::default(); let mut options = FormatOptions::default();
options.set_padding(true); options.set_padding(true);
assert_eq!(Format::Dec.format(1337, &options), "1337"); assert_eq!(Format::Dec.format_str(1337, &options), "1337");
assert_eq!( assert_eq!(
Format::Dec.format(u128::MAX, &options), Format::Dec.format_str(u128::MAX, &options),
format!("{}", u128::MAX) format!("{}", u128::MAX)
); );
assert_eq!(Format::Hex.format(0xFFF, &options), "0FFF"); assert_eq!(Format::Hex.format_str(0xFFF, &options), "0FFF");
assert_eq!(Format::Hex.format(0xFFFF, &options), "FFFF"); assert_eq!(Format::Hex.format_str(0xFFFF, &options), "FFFF");
assert_eq!( assert_eq!(
Format::Hex.format(u128::MAX, &options), Format::Hex.format_str(u128::MAX, &options),
format!("{:X}", u128::MAX) format!("{:X}", u128::MAX)
); );
assert_eq!( assert_eq!(
Format::Bin.format(0b11110000_00001111, &options), Format::Bin.format_str(0b11110000_00001111, &options),
"1111000000001111" "1111000000001111"
); );
assert_eq!( assert_eq!(
Format::Bin.format(0b110000_00001111, &options), Format::Bin.format_str(0b110000_00001111, &options),
"0011000000001111" "0011000000001111"
); );
assert_eq!( assert_eq!(
Format::Bin.format(u128::MAX, &options), Format::Bin.format_str(u128::MAX, &options),
format!("{:b}", u128::MAX) format!("{:b}", u128::MAX)
); );
assert_eq!(Format::Octal.format(0o13377331, &options), "13377331"); assert_eq!(Format::Octal.format_str(0o13377331, &options), "13377331");
assert_eq!( assert_eq!(
Format::Octal.format(u128::MAX, &options), Format::Octal.format_str(u128::MAX, &options),
format!("{:o}", u128::MAX) format!("{:o}", u128::MAX)
); );
assert_eq!(Format::Base32.format(0x41414242, &options), "IFAUEQQ="); assert_eq!(Format::Base32.format_str(0x41414242, &options), "IFAUEQQ=");
assert_eq!( assert_eq!(
Format::Base32.format(0x4141414141414141, &options), Format::Base32.format_str(0x4141414141414141, &options),
"IFAUCQKBIFAUC===" "IFAUCQKBIFAUC==="
); );
assert_eq!(Format::Base64.format(0x41414242, &options), "QUFCQg=="); assert_eq!(Format::Base64.format_str(0x41414242, &options), "QUFCQg==");
assert_eq!( assert_eq!(
Format::Base64.format(0x4141414141414141, &options), Format::Base64.format_str(0x4141414141414141, &options),
"QUFBQUFBQUE=" "QUFBQUFBQUE="
); );
} }
@ -98,42 +98,48 @@ fn format_prefix() {
let mut options = FormatOptions::default(); let mut options = FormatOptions::default();
options.set_prefix(true); options.set_prefix(true);
assert_eq!(Format::Dec.format(1337, &options), "0d1337"); assert_eq!(Format::Dec.format_str(1337, &options), "0d1337");
assert_eq!( assert_eq!(
Format::Dec.format(u128::MAX, &options), Format::Dec.format_str(u128::MAX, &options),
format!("0d{}", u128::MAX) format!("0d{}", u128::MAX)
); );
assert_eq!(Format::Hex.format(0x1337, &options), "0x1337"); assert_eq!(Format::Hex.format_str(0x1337, &options), "0x1337");
assert_eq!( assert_eq!(
Format::Hex.format(u128::MAX, &options), Format::Hex.format_str(u128::MAX, &options),
format!("0x{:X}", u128::MAX) format!("0x{:X}", u128::MAX)
); );
assert_eq!( assert_eq!(
Format::Bin.format(0b1010001001010010010100111, &options), Format::Bin.format_str(0b1010001001010010010100111, &options),
"0b1010001001010010010100111" "0b1010001001010010010100111"
); );
assert_eq!( assert_eq!(
Format::Bin.format(u128::MAX, &options), Format::Bin.format_str(u128::MAX, &options),
format!("0b{:b}", u128::MAX) format!("0b{:b}", u128::MAX)
); );
assert_eq!(Format::Octal.format(0o13377331, &options), "0o13377331"); assert_eq!(Format::Octal.format_str(0o13377331, &options), "0o13377331");
assert_eq!( assert_eq!(
Format::Octal.format(u128::MAX, &options), Format::Octal.format_str(u128::MAX, &options),
format!("0o{:o}", u128::MAX) format!("0o{:o}", u128::MAX)
); );
assert_eq!(Format::Base32.format(0x41414242, &options), "032sIFAUEQQ=");
assert_eq!( assert_eq!(
Format::Base32.format(0x4141414141414141, &options), Format::Base32.format_str(0x41414242, &options),
"032sIFAUEQQ="
);
assert_eq!(
Format::Base32.format_str(0x4141414141414141, &options),
"032sIFAUCQKBIFAUC===" "032sIFAUCQKBIFAUC==="
); );
assert_eq!(Format::Base64.format(0x41414242, &options), "0sQUFCQg==");
assert_eq!( assert_eq!(
Format::Base64.format(0x4141414141414141, &options), Format::Base64.format_str(0x41414242, &options),
"0sQUFCQg=="
);
assert_eq!(
Format::Base64.format_str(0x4141414141414141, &options),
"0sQUFBQUFBQUE=" "0sQUFBQUFBQUE="
); );
} }
@ -144,47 +150,53 @@ fn format_padded_prefix() {
options.set_prefix(true); options.set_prefix(true);
options.set_padding(true); options.set_padding(true);
assert_eq!(Format::Dec.format(1337, &options), "0d1337"); assert_eq!(Format::Dec.format_str(1337, &options), "0d1337");
assert_eq!( assert_eq!(
Format::Dec.format(u128::MAX, &options), Format::Dec.format_str(u128::MAX, &options),
format!("0d{}", u128::MAX) format!("0d{}", u128::MAX)
); );
assert_eq!(Format::Hex.format(0xFFF, &options), "0x0FFF"); assert_eq!(Format::Hex.format_str(0xFFF, &options), "0x0FFF");
assert_eq!(Format::Hex.format(0xFFFF, &options), "0xFFFF"); assert_eq!(Format::Hex.format_str(0xFFFF, &options), "0xFFFF");
assert_eq!( assert_eq!(
Format::Hex.format(u128::MAX, &options), Format::Hex.format_str(u128::MAX, &options),
format!("0x{:X}", u128::MAX) format!("0x{:X}", u128::MAX)
); );
assert_eq!( assert_eq!(
Format::Bin.format(0b11110000_00001111, &options), Format::Bin.format_str(0b11110000_00001111, &options),
"0b1111000000001111" "0b1111000000001111"
); );
assert_eq!( assert_eq!(
Format::Bin.format(0b110000_00001111, &options), Format::Bin.format_str(0b110000_00001111, &options),
"0b0011000000001111" "0b0011000000001111"
); );
assert_eq!( assert_eq!(
Format::Bin.format(u128::MAX, &options), Format::Bin.format_str(u128::MAX, &options),
format!("0b{:b}", u128::MAX) format!("0b{:b}", u128::MAX)
); );
assert_eq!(Format::Octal.format(0o13377331, &options), "0o13377331"); assert_eq!(Format::Octal.format_str(0o13377331, &options), "0o13377331");
assert_eq!( assert_eq!(
Format::Octal.format(u128::MAX, &options), Format::Octal.format_str(u128::MAX, &options),
format!("0o{:o}", u128::MAX) format!("0o{:o}", u128::MAX)
); );
assert_eq!(Format::Base32.format(0x41414242, &options), "032sIFAUEQQ=");
assert_eq!( assert_eq!(
Format::Base32.format(0x4141414141414141, &options), Format::Base32.format_str(0x41414242, &options),
"032sIFAUEQQ="
);
assert_eq!(
Format::Base32.format_str(0x4141414141414141, &options),
"032sIFAUCQKBIFAUC===" "032sIFAUCQKBIFAUC==="
); );
assert_eq!(Format::Base64.format(0x41414242, &options), "0sQUFCQg==");
assert_eq!( assert_eq!(
Format::Base64.format(0x4141414141414141, &options), Format::Base64.format_str(0x41414242, &options),
"0sQUFCQg=="
);
assert_eq!(
Format::Base64.format_str(0x4141414141414141, &options),
"0sQUFBQUFBQUE=" "0sQUFBQUFBQUE="
); );
} }
@ -197,6 +209,8 @@ fn set_format_checker() {
assert_eq!(options.format(), Format::Base32); assert_eq!(options.format(), Format::Base32);
options.set_format(Format::Base64); options.set_format(Format::Base64);
assert_eq!(options.format(), Format::Base64); assert_eq!(options.format(), Format::Base64);
options.set_format(Format::Raw);
assert_eq!(options.format(), Format::Raw);
} }
#[test] #[test]