Skip to content

Commit 342ef21

Browse files
author
Rouven Spreckels
committed
Initial commit
0 parents  commit 342ef21

File tree

6 files changed

+1332
-0
lines changed

6 files changed

+1332
-0
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
target
2+
Cargo.lock

‎COPYING

+674
Large diffs are not rendered by default.

‎COPYING.LESSER

+165
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

‎Cargo.toml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
[package]
2+
name = "signifix"
3+
version = "0.1.0"
4+
authors = ["Rouven Spreckels <[email protected]>"]
5+
description = "Number Formatter of Fixed Significance with Metric Unit Prefix"
6+
documentation = "https://docs.rs/signifix/0.1.0/signifix/"
7+
homepage = "https://qu1x.org/signifix"
8+
repository = "https://github.com/qu1x/signifix"
9+
readme = "README.md"
10+
keywords = [ "number", "format", "significant", "unit", "prefix" ]
11+
license = "LGPL-3.0"
12+
include = [ "src/lib.rs", "Cargo.toml", "COPYING", "COPYING.LESSER" ]

‎README.md

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# signifix
2+
3+
Number Formatter of Fixed Significance with Metric Unit Prefix
4+
5+
Signifix guarantees a fixed number of significant figures and a fixed number
6+
of resulting characters by automatically choosing the metric unit prefix and
7+
appropriately adjusting the floating point precision.
8+
9+
## Usage
10+
11+
This crate is [on crates.io](https://crates.io/crates/signifix) and can be
12+
used by adding `signifix` to the dependencies in your project's
13+
`Cargo.toml`:
14+
15+
```toml
16+
[dependencies]
17+
signifix = "0.1.0"
18+
```
19+
20+
and this to your crate root:
21+
22+
```rust
23+
extern crate signifix;
24+
```
25+
26+
## Examples
27+
28+
The fixed number of significant figures and resulting characters prevent the
29+
digits and prefixed units from jumping to the left or right:
30+
31+
```rust
32+
#![feature(try_from)]
33+
use std::convert::TryFrom;
34+
35+
use signifix::{Signifix, Result};
36+
37+
let format = |number| -> Result<String> {
38+
Ok(format!("{}", Signifix::try_from(number)?))
39+
};
40+
41+
assert_eq!(format(1e-04).ok(), Some("100.0 µ".into()));
42+
assert_eq!(format(1e-03).ok(), Some("1.000 m".into()));
43+
assert_eq!(format(1e-02).ok(), Some("10.00 m".into()));
44+
assert_eq!(format(1e-01).ok(), Some("100.0 m".into()));
45+
assert_eq!(format(1e+00).ok(), Some("1.000 ".into()));
46+
assert_eq!(format(1e+01).ok(), Some("10.00 ".into()));
47+
assert_eq!(format(1e+02).ok(), Some("100.0 ".into()));
48+
assert_eq!(format(1e+03).ok(), Some("1.000 k".into()));
49+
assert_eq!(format(1e+04).ok(), Some("10.00 k".into()));
50+
assert_eq!(format(1e+05).ok(), Some("100.0 k".into()));
51+
assert_eq!(format(1e+06).ok(), Some("1.000 M".into()));
52+
```
53+
54+
This is useful to smoothly refresh a transfer rate inside a terminal:
55+
56+
```rust
57+
#![feature(try_from)]
58+
use std::convert::TryFrom;
59+
60+
use signifix::{Signifix, Result};
61+
62+
let format_rate = |bytes, seconds| -> Result<String> {
63+
Ok(format!("{}B/s", Signifix::try_from(bytes as f64 / seconds as f64)?))
64+
};
65+
66+
assert_eq!(format_rate(42_667, 300).ok(), Some("142.2 B/s".into()));
67+
assert_eq!(format_rate(42_667, 30).ok(), Some("1.422 kB/s".into()));
68+
assert_eq!(format_rate(42_667, 3).ok(), Some("14.22 kB/s".into()));
69+
```
70+
71+
Or to monitor a measured quantity like an electrical current including its
72+
direction with an optional space placeholder to align with negative values.
73+
74+
```rust
75+
#![feature(try_from)]
76+
use std::convert::TryFrom;
77+
78+
use signifix::{Signifix, Result};
79+
80+
let format_load = |current| -> Result<String> {
81+
Ok(format!("{:#}A", Signifix::try_from(current)?))
82+
};
83+
84+
assert_eq!(format_load( 1.476e-06).ok(), Some(" 1.476 µA".into()));
85+
assert_eq!(format_load(-2.927e-06).ok(), Some("-2.927 µA".into()));
86+
```
87+
88+
In case of displaying a file size difference after modification, a plus sign
89+
might be preferred for positive values:
90+
91+
```rust
92+
#![feature(try_from)]
93+
use std::convert::TryFrom;
94+
95+
use signifix::{Signifix, Result};
96+
97+
let format_diff = |curr, prev| -> Result<String> {
98+
Ok(format!("{:+}B", Signifix::try_from(curr - prev)?))
99+
};
100+
101+
assert_eq!(format_diff(78_346, 57_393).ok(), Some("+20.95 kB".into()));
102+
assert_eq!(format_diff(27_473, 46_839).ok(), Some("-19.37 kB".into()));
103+
```

0 commit comments

Comments
 (0)