#sort #path #file #number #alphanumeric

no-std alphanumeric-sort

This crate can help you sort order for files and folders whose names contain numerals

23 stable releases

new 1.4.0 Jul 30, 2020
1.3.2 Jun 27, 2020
1.0.12 Feb 20, 2020
1.0.11 Sep 16, 2019
1.0.6 Nov 13, 2018

#12 in Algorithms

Download history 360/week @ 2020-04-14 610/week @ 2020-04-21 700/week @ 2020-04-28 772/week @ 2020-05-05 574/week @ 2020-05-12 707/week @ 2020-05-19 436/week @ 2020-05-26 342/week @ 2020-06-02 504/week @ 2020-06-09 469/week @ 2020-06-16 851/week @ 2020-06-23 443/week @ 2020-06-30 299/week @ 2020-07-07 707/week @ 2020-07-14 718/week @ 2020-07-21 379/week @ 2020-07-28

2,439 downloads per month
Used in less than 8 crates

MIT license

27KB
623 lines

Alphanumeric Sort

Build Status

This crate can help you sort order for files and folders whose names contain numerals.

Motives and Examples

With the Rust native sort method, strings and paths are arranged into lexicographical order. In some cases, it is not so intuitive. For example, there are screen snap shots named by shot-%N like shot-2, shot-1, shot-11. After a lexicographical sorting, they will be ordered into shot-1, shot-11, shot-2. However, we would prefer shot-1, shot-2, shot-11 mostly.

let mut names = ["shot-2", "shot-1", "shot-11"];

names.sort();

assert_eq!(["shot-1", "shot-11", "shot-2"], names);

Thus, in this kind of case, an alphanumeric sort might come in handy.

extern crate alphanumeric_sort;

let mut names = ["shot-2", "shot-1", "shot-11"];

alphanumeric_sort::sort_str_slice(&mut names);

assert_eq!(["shot-1", "shot-2", "shot-11"], names);
extern crate alphanumeric_sort;

use std::path::Path;

let mut paths = [Path::new("shot-2"), Path::new("shot-1"), Path::new("shot-11")];

alphanumeric_sort::sort_path_slice(&mut paths);

assert_eq!([Path::new("shot-1"), Path::new("shot-2"), Path::new("shot-11")], paths);

About the compare_* Functions and the sort_* Functions

To sort a slice, the code can also be written like,

extern crate alphanumeric_sort;

use std::path::Path;

let mut paths = [Path::new("shot-2"), Path::new("shot-1"), Path::new("shot-11")];

paths.sort_by(|a, b| alphanumeric_sort::compare_path(a, b));

assert_eq!([Path::new("shot-1"), Path::new("shot-2"), Path::new("shot-11")], paths);

But it is not recommended because the compare_* functions try to convert data (e.g Path, CStr) to &str every time in its execution and thus they are slower than the sort_* functions when sorting a slice.

Version 1.3 to 1.4

No breaking change in API is made, though the order has some changes.

  • "0001" is greater than "001" instead of being equal.
  • "" is greater than "1" instead of being less. "第1章" is still less than "第1-2章", even though "" is greater than "-".

No Std

Disable the default features to compile this crate without std.

[dependencies.alphanumeric-sort]
version = "*"
default-features = false

Benchmark

cargo bench

Crates.io

https://crates.io/crates/alphanumeric-sort

Documentation

https://docs.rs/alphanumeric-sort

License

MIT

No runtime deps