Merge branch 'master' into fix-inverted-si-conditions

Author: Andrew15-5

.github/workflows/ci.yml

@@ -0,0 +1,57 @@
+name: CI
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+  merge_group:
+    types: [checks_requested]
+  push:
+    branches: [master]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  read_msrv:
+    name: Read MSRV
+    uses: actions-rust-lang/msrv/.github/workflows/[email protected]
+
+  rust:
+    needs: read_msrv
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - { name: Linux, runner: ubuntu-latest }
+          - { name: macOS, runner: macos-latest }
+          - { name: Windows, runner: windows-latest }
+        toolchain:
+          - { name: stable, version: stable }
+          - { name: msrv, version: "${{ needs.read_msrv.outputs.msrv }}" }
+
+    name: ${{ matrix.os.name }} / ${{ matrix.toolchain.name }}
+    runs-on: ${{ matrix.os.runner }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust (${{ matrix.toolchain.name }})
+        uses: actions-rust-lang/[email protected]
+        with:
+          toolchain: ${{ matrix.toolchain.version }}
+
+      - name: Install just, nextest
+        uses: taiki-e/[email protected]
+        with:
+          tool: just,nextest
+
+      - name: Test
+        run: just test

.github/workflows/coverage.yml

@@ -0,0 +1,39 @@
+name: Coverage
+
+on:
+  push:
+    branches: [master]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: actions-rust-lang/[email protected]
+        with:
+          components: llvm-tools-preview
+
+      - name: Install just & cargo-llvm-cov
+        uses: taiki-e/[email protected]
+        with:
+          tool: just,cargo-llvm-cov
+
+      - name: Generate code coverage
+        run: just test-coverage-codecov
+
+      - name: Upload coverage to Codecov
+        uses: codecov/[email protected]
+        with:
+          files: codecov.json
+          fail_ci_if_error: true
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/lint.yml

@@ -0,0 +1,84 @@
+name: Lint
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  clippy:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      checks: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: actions-rust-lang/[email protected]
+        with:
+          components: clippy
+
+      - name: Install just, cargo-hack
+        uses: taiki-e/[email protected]
+        with:
+          tool: just,cargo-hack
+
+      - name: Check with Clippy
+        run: just clippy
+
+  rustfmt:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust (nightly)
+        uses: actions-rust-lang/[email protected]
+        with:
+          toolchain: nightly
+          components: rustfmt
+
+      - name: Check with Rustfmt
+        run: cargo fmt -- --check
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust (nightly)
+        uses: actions-rust-lang/[email protected]
+        with:
+          toolchain: nightly
+          components: rust-docs
+
+      - name: Check for broken intra-doc links
+        env:
+          RUSTDOCFLAGS: -D warnings
+        run: cargo doc --workspace --no-deps --all-features
+
+  sorted-deps:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: actions-rust-lang/[email protected]
+        with:
+          components: clippy
+
+      - name: Install just, cargo-sort
+        uses: taiki-e/[email protected]
+        with:
+          tool: just,cargo-sort
+
+      - name: Check dependency requirements are sorted lexicographically
+        run: cargo sort --workspace --check

.github/workflows/rust.yml

@@ -0,0 +1,5 @@
+# Changelog
+
+## Unreleased
+- Use SI format by default with `Display`.
+- Use "KiB" for SI unit.

CHANGELOG.md

@@ -1,24 +1,23 @@
 [package]
 name = "bytesize"
-description = "an utility for human-readable bytes representations"
-version = "1.4.0-dev"
-authors = ["Hyunsik Choi <[email protected]>"]
-
-homepage = "https://github.com/hyunsik/bytesize/"
-documentation = "https://docs.rs/bytesize/"
-repository = "https://github.com/hyunsik/bytesize/"
-readme = "README.md"
+description = "A utility for human-readable byte count representations"
+version = "1.3.0"
+authors = ["Hyunsik Choi <[email protected]>", "MrCroxx <[email protected]>"]
 keywords = ["byte", "byte-size", "utility", "human-readable", "format"]
+categories = ["development-tools", "filesystem"]
+repository = "https://github.com/hyunsik/bytesize"
 license = "Apache-2.0"
+edition = "2021"
+rust-version = "1.65"
 
 [dependencies]
-arbitrary = { version = "1.3.0", optional = true }
-serde = { version = "1.0.185", optional = true }
+arbitrary = { version = "1", features = ["derive"], optional = true }
+serde = { version = "1", optional = true }
 
 [dev-dependencies]
-serde = { version = "1.0.185", features = ["derive"] }
-serde_json = "1.0.105"
-toml = "0.7.6"
+serde = { version = "1", features = ["derive"] }
+serde_json = "1"
+toml = "0.8"
 
 [features]
 arbitrary = ["dep:arbitrary"]

Cargo.toml

@@ -1,37 +1,25 @@
 ## ByteSize
-[![Build Status](https://travis-ci.org/hyunsik/bytesize.svg?branch=master)](https://travis-ci.org/hyunsik/bytesize)
-[![Crates.io Version](https://img.shields.io/crates/v/bytesize.svg)](https://crates.io/crates/bytesize)
 
+[![CI](https://github.com/hyunsik/bytesize/actions/workflows/ci.yml/badge.svg)](https://github.com/hyunsik/bytesize/actions/workflows/ci.yml)
+[![Crates.io Version](https://img.shields.io/crates/v/bytesize.svg)](https://crates.io/crates/bytesize)
 
-ByteSize is an utility for human-readable byte count representation.
+`ByteSize` is a utility for human-readable byte count representations.
 
 Features:
-* Pre-defined constants for various size units (e.g., B, Kb, kib, Mb, Mib, Gb, Gib, ... PB)
-* `ByteSize` type which presents size units convertible to different size units.
-* Artimetic operations for `ByteSize`
-* FromStr impl for `ByteSize`, allowing to parse from string size representations like 1.5KiB and 521TiB.
-* Serde support for binary and human-readable deserializers like JSON
 
-[API Documentation](https://docs.rs/bytesize/)
+- Pre-defined constants for various size units (e.g., B, KB, KiB, MB, MiB, GB, GiB, ... PiB).
+- `ByteSize` type which presents size units convertible to different size units.
+- Arithmetic operations for `ByteSize`.
+- FromStr impl for `ByteSize`, allowing to parse from string size representations like 1.5KiB and 521TiB.
+- Serde support for binary and human-readable deserializers like JSON.
 
-## Usage
+[API Documentation](https://docs.rs/bytesize)
 
-Add this to your Cargo.toml:
+## Example
 
-```toml
-[dependencies]
-bytesize = {version = "1.2.0", features = ["serde"]}
-```
+### Human readable representations (SI unit and Binary unit)
 
-and this to your crate root:
 ```rust
-extern crate bytesize;
-```
-
-## Example
-### Human readable representations (SI units and Binary units)
-```rust
-#[allow(dead_code)]
 fn assert_display(expected: &str, b: ByteSize) {
     assert_eq!(expected, format!("{}", b));
 }
@@ -47,26 +35,42 @@ fn test_display() {
     assert_display("609.0 PiB", ByteSize::pib(609));
 }
 
+#[test]
+fn test_display_alignment() {
+    assert_eq!("|357 B     |", format!("|{:10}|", ByteSize(357)));
+    assert_eq!("|     357 B|", format!("|{:>10}|", ByteSize(357)));
+    assert_eq!("|357 B     |", format!("|{:<10}|", ByteSize(357)));
+    assert_eq!("|  357 B   |", format!("|{:^10}|", ByteSize(357)));
+
+    assert_eq!("|-----357 B|", format!("|{:->10}|", ByteSize(357)));
+    assert_eq!("|357 B-----|", format!("|{:-<10}|", ByteSize(357)));
+    assert_eq!("|--357 B---|", format!("|{:-^10}|", ByteSize(357)));
+}
+
 fn assert_to_string(expected: &str, b: ByteSize, si: bool) {
     assert_eq!(expected.to_string(), b.to_string_as(si));
 }
 
 #[test]
 fn test_to_string_as() {
+    assert_to_string("215 B", ByteSize::b(215), true);
     assert_to_string("215 B", ByteSize::b(215), false);
     assert_to_string("215 B", ByteSize::b(215), true);
 
-    assert_to_string("1.0 KiB", ByteSize::kib(1), false);
-    assert_to_string("1.0 kB", ByteSize::kib(1), true);
+    assert_to_string("1.0 KiB", ByteSize::kib(1), true);
+    assert_to_string("1.0 KB", ByteSize::kib(1), false);
 
-    assert_to_string("293.9 KiB", ByteSize::kb(301), false);
-    assert_to_string("301.0 kB", ByteSize::kb(301), true);
+    assert_to_string("293.9 KiB", ByteSize::kb(301), true);
+    assert_to_string("301.0 KB", ByteSize::kb(301), false);
 
     assert_to_string("1.0 MiB", ByteSize::mib(1), false);
     assert_to_string("1048.6 kB", ByteSize::mib(1), true);
 
-    assert_to_string("1.9 GiB", ByteSize::mib(1907), false);
-    assert_to_string("2.0 GB", ByteSize::mib(1908), true);
+    assert_to_string("1.9 GiB", ByteSize::mib(1907), true);
+    assert_to_string("2.0 GB", ByteSize::mib(1908), false);
+
+    assert_to_string("399.6 MiB", ByteSize::mb(419), true);
+    assert_to_string("419.0 MB", ByteSize::mb(419), false);
 
     assert_to_string("399.6 MiB", ByteSize::mb(419), false);
     assert_to_string("419.0 MB", ByteSize::mb(419), true);
@@ -88,30 +92,14 @@ fn test_parsing_from_str() {
         s.parse::<ByteSize>().unwrap().0
     }
 
-    assert_eq!("0".parse::<ByteSize>().unwrap().0, 0);
-    assert_eq!(parse("0"), 0);
-    assert_eq!(parse("500"), 500);
-    assert_eq!(parse("1K"), Unit::KiloByte * 1);
-    assert_eq!(parse("1Ki"), Unit::KibiByte * 1);
-    assert_eq!(parse("1.5Ki"), (1.5 * Unit::KibiByte) as u64);
-    assert_eq!(parse("1KiB"), 1 * Unit::KibiByte);
-    assert_eq!(parse("1.5KiB"), (1.5 * Unit::KibiByte) as u64);
-    assert_eq!(parse("3 MB"), Unit::MegaByte * 3);
-    assert_eq!(parse("4 MiB"), Unit::MebiByte * 4);
-    assert_eq!(parse("6 GB"), 6 * Unit::GigaByte);
-    assert_eq!(parse("4 GiB"), 4 * Unit::GibiByte);
-    assert_eq!(parse("88TB"), 88 * Unit::TeraByte);
-    assert_eq!(parse("521TiB"), 521 * Unit::TebiByte);
-    assert_eq!(parse("8 PB"), 8 * Unit::PetaByte);
-    assert_eq!(parse("8P"), 8 * Unit::PetaByte);
-    assert_eq!(parse("12 PiB"), 12 * Unit::PebiByte);
+    assert_to_string("540.9 PiB", ByteSize::pb(609), false);
+    assert_to_string("609.0 PB", ByteSize::pb(609), true);
 }
 ```
 
 ### Arithmetic operations
-```rust
-extern crate bytesize;
 
+```rust
 use bytesize::ByteSize;
 
 fn byte_arithmetic_operator() {