Skip to content

A lightweight number-formatting library for Rust.

License

Notifications You must be signed in to change notification settings

Blobfolio/dactyl

Repository files navigation

Dactyl

docs.rs changelog
crates.io ci deps.rs
license contributions welcome

This crate provides a fast interface to "stringify" unsigned integers, formatted with commas at each thousand. It prioritizes speed and simplicity over configurability.

If your application just wants to quickly turn 1010 into "1,010", Dactyl is a great choice. If your application requires locale awareness or other options, something like num-format would probably make more sense.

Similar to itoa, Dactyl writes ASCII conversions to a temporary buffer, but does so using fixed arrays sized for each type's maximum value, minimizing the allocation overhead for, say, tiny little u8s.

Each type has its own struct, each of which works exactly the same way:

  • NiceU8
  • NiceU16
  • NiceU32
  • NiceU64 (also covers usize)
  • NiceFloat
  • NiceElapsed (for durations)
  • NicePercent (for floats representing percentages)

The intended use case is to simply call the appropriate from() for the type, then use either the as_str() or as_bytes() struct methods to retrieve the output in the desired format. Each struct also implements traits like Deref, Display, AsRef<str>, AsRef<[u8]>, etc., if you prefer those.

use dactyl::NiceU16;

assert_eq!(NiceU16::from(11234_u16).as_str(), "11,234");
assert_eq!(NiceU16::from(11234_u16).as_bytes(), b"11,234");

But the niceness doesn't stop there. Dactyl provides several other structs, methods, and traits to performantly work with integers, such as:

  • NoHash: a passthrough hasher for integer HashSet/HashMap collections
  • traits::BytesToSigned: signed integer parsing from byte slices
  • traits::BytesToUnsigned: unsigned integer parsing from byte slices
  • traits::HexToSigned: signed integer parsing from hex
  • traits::HexToUnsigned: unsigned integer parsing from hex

Installation

Add dactyl to your dependencies in Cargo.toml, like:

[dependencies]
dactyl = "0.7.*"

License

See also: CREDITS.md

Copyright © 2024 Blobfolio, LLC <[email protected]>

This work is free. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2.

DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004

Copyright (C) 2004 Sam Hocevar <[email protected]>

Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.

DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

0. You just DO WHAT THE FUCK YOU WANT TO.