Crate alphanumeric_sort

Expand description

Alphanumeric Sort

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

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.

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);

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,

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

Functions

Compare two CStr.

Compare two OsStr.

Compare two Path.

Compare two strings.

Sort a CStr slice.

Reversely sort a CStr slice.

sort_os_str_slice

Sort an OsStr slice.

sort_os_str_slice_rev

Reversely sort an OsStr slice.

sort_path_slice

Sort a Path slice.

sort_path_slice_rev

Reversely sort a Path slice.

sort_slice_by_c_str_key

Sort a slice by a CStr key.

sort_slice_by_os_str_key

Sort a slice by an OsStr key.

sort_slice_by_path_key

Sort a slice by a Path key.

sort_slice_by_str_key

Sort a slice by a str key.

sort_slice_rev_by_c_str_key

Reversely sort a slice by a CStr key.

sort_slice_rev_by_os_str_key

Reversely sort a slice by an OsStr key.

sort_slice_rev_by_path_key

Reversely sort a slice by a Path key.

sort_slice_rev_by_str_key

Reversely sort a slice by a str key.

sort_slice_rev_unstable_by_c_str_key

Reversely sort a slice by a CStr key, but may not preserve the order of equal elements.

sort_slice_rev_unstable_by_os_str_key

Reversely sort a slice by an OsStr key, but may not preserve the order of equal elements.

sort_slice_rev_unstable_by_path_key

Reversely sort a slice by a Path key, but may not preserve the order of equal elements.

sort_slice_rev_unstable_by_str_key

Reversely sort a slice by a str key, but may not preserve the order of equal elements.

sort_slice_unstable_by_c_str_key

Sort a slice by a CStr key, but may not preserve the order of equal elements.

sort_slice_unstable_by_os_str_key

Sort a slice by an OsStr key, but may not preserve the order of equal elements.

sort_slice_unstable_by_path_key

Sort a slice by a Path key, but may not preserve the order of equal elements.

sort_slice_unstable_by_str_key

Sort a slice by a str key, but may not preserve the order of equal elements.

sort_str_slice

Sort a str slice.

sort_str_slice_rev

Reversely sort a str slice.