#byte-size #human-readable #utility #no-std

no-std bytelike

Common types and functions for byte size handling

6 releases

0.1.11 Jan 30, 2025
0.1.10 Jan 30, 2025
0.1.3 Nov 15, 2024

#754 in Rust patterns

Download history 283/week @ 2024-11-12 28/week @ 2024-11-19 3/week @ 2024-11-26 8/week @ 2024-12-24 237/week @ 2025-01-28 42/week @ 2025-02-04

279 downloads per month

Apache-2.0

9KB
150 lines

ByteLike

Crates.io Version

ByteLike is a procedural macro crate for deriving ByteLike functions for deriving byte-like new types.

It's a procedural macro that was created based off the implementation of ByteSize.

Usage

Add this to your Cargo.toml

[dependencies]
bytelike = { version = "0.1", features = ["serde"] }

Or if don't want serde:

[dependencies]
bytelike = { version = "0.1" }

Note, you can also disable std:

[dependencies]
bytelike = { version = "0.1", no-default-features = true }

Next, define your new type and derive ByteLike for it:

use bytelike_derive::ByteLike;

#[derive(ByteLike)]
pub struct NewType(pub u64);

Now you can do lots of useful byte-like things with your new type:

let new_type_a: NewType = "5KiB".parse().unwrap();
let new_type_b: NewType = NewType::kib(5);
let sum = new_type + other_type;
let sum = new_type + 5;

See the documentation for ByteSize to see more examples of what you can do with the ByteLike new type (just replace ByteSize with your new type name).

In addition, if you only want some of the ByteLike functions derived, you can use any of the following derives in an additive manner:

  • ByteLikeConstructor
  • ByteLikeDisplay
  • ByteLikeParse
  • ByteLikeOps
  • ByteLikeFromStr
  • ByteLikeSerde (requires the serde feature)

Dependencies

~155KB