⚡️Highly efficient data and string formatting library for Rust.
🔎 Overview
Pad and format string slices and generic vectors efficiently with minimal memory allocation. This crate has guaranteed performance improvements over the standard library format! macro. Clone this repo and run cargo bench to see benchmark comparisons between our implementation and the standard library.
The library defines a core trait called Source and also has this implemented on two main types of datastructures, the string slice &str and a generic vector Vec<T> with some trait bounds on the type T. This allows for any developer to implement the trait on any datastructure that they want to be able to pad or format using any of the padding modes defined in the crate.
📦 Installation
The easiest way to include padder in your projects is by using the Cargo package manager.
$ cargo add padder
Alternatively, you can build from source by cloning this repo and compiling using Cargo and then linking the library to your project.
$ git clone https://github.com/firelink-data/padder.git
$ cd padder
$ cargo build --release
🚀 Examples
Adding padder to your crate dependecy will bring the Source trait into scope and allow padding.
You can for example pad string slices very easily in the following way:
let padded: String = "cool".pad(10, Alignment::Center, Symbol::Zero);
which would produce the padded String 000cool000. You can also pad to an already allocated buffer, allowing you full control of heap allocations, like below:
let width: usize = 8;
let mut output: Vec<u8> = Vec::with_capacity(width);
let original = vec![13u8, 9, 128, 81];
original.pad_and_push_to_buffer(width, Alignment::Right, Symbol::Whitespace, output);
There also exists two wrapper methods simply called pad and pad_and_push_to_buffer which allows padding any object as long as it implements the Source trait. You can for example use these functions like below:
// pad
let original: &str = "hej";
let width: usize = 9;
let output: String = pad(original, width, Alignment::Left, Symbol::Hyphen);
// pad_and_push_to_buffer
let buffer = String::with_capacity(11);
pad_and_push_to_buffer("testcool", 11, Alignment::Right, Symbol::Whitespace);
which would produce the strings hej------ and testcool.
📋 License
All code is to be held under a general MIT license, please see LICENSE for specific information.
20 Apr 14, 2022
0 Feb 4, 2022
4 Aug 4, 2022
6 Dec 19, 2022
29 Dec 11, 2022
57 Nov 20, 2022
17 Dec 20, 2022
43 Dec 12, 2022
2 Dec 21, 2022
75 Jul 28, 2022
13 Nov 2, 2022
18 Jul 3, 2021
15 Dec 23, 2022
397 Jan 9, 2023
1.7k Jan 8, 2023
40 Apr 20, 2023
58 Dec 26, 2022
18 Jan 22, 2023
7 Nov 21, 2023