[][src]Crate thousands

Provides a trait, Separable, for formatting numbers with separators between the digits. Typically this will be used to add commas or spaces every three digits from the right, but can be configured via a SeparatorPolicy.

Examples

The simplest way to use the library is with trait Separable’s method separate_with_commas method, which does what it sounds like:

use thousands::Separable;

assert_eq!(   12345  .separate_with_commas(),  "12,345" );
assert_eq!( (-12345) .separate_with_commas(), "-12,345" );
assert_eq!(    9876.5.separate_with_commas(),   "9,876.5" );

There are also methods separate_with_spaces and separate_with_dots, in case you prefer those separators.

However, it's also possible to pass a policy for different behavior:

use thousands::{Separable, SeparatorPolicy, digits};

let policy = SeparatorPolicy {
    separator: ',',
    groups:    &[3, 2],
    digits:    digits::ASCII_DECIMAL,
};

assert_eq!( 1234567890.separate_by_policy(policy), "1,23,45,67,890" );

Usage

It’s on crates.io, so you can add

[dependencies]
thousands = "0.1.3"

to your Cargo.toml.

This crate supports Rust version 1.17 and newer.

Modules

digits

Collections of digits.

policies

Predefined policies.

Structs

SeparatorPolicy

A policy for inserting separators into numbers.

Traits

Separable

Provides methods for formatting numbers with separators between the digits.