into-sorted 0.0.3

Collection of utility methods and functions that take an owned array and return a sorted owned array
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

use core::cmp::Ordering;

/// Sort an array by [`Ord`] and return it.
///
/// This function calls [`slice::sort`] under the hook.
///
/// [`slice::sort`]: https://doc.rust-lang.org/std/primitive.slice.html#method.sort
#[inline]
pub fn into_sorted<Item, Array>(mut array: Array) -> Array
where
    Array: AsMut<[Item]>,
    Item: Ord,
{
    array.as_mut().sort();
    array
}

/// Sort an array by a function and return it.
///
/// This function calls [`slice::sort_by`] under the hook.
///
/// [`slice::sort_by`]: https://doc.rust-lang.org/std/primitive.slice.html#method.sort_by
#[inline]
pub fn into_sorted_by<Item, Array, Order>(mut array: Array, order: Order) -> Array
where
    Array: AsMut<[Item]>,
    Order: FnMut(&Item, &Item) -> Ordering,
{
    array.as_mut().sort_by(order);
    array
}

/// Sort an array by a key extraction function and return it.
///
/// This function calls [`slice::sort_by_key`] under the hook.
///
/// [`slice::sort_by_key`]: https://doc.rust-lang.org/std/primitive.slice.html#method.sort_by_key
#[inline]
pub fn into_sorted_by_key<Item, Array, Key, GetKey>(mut array: Array, get_key: GetKey) -> Array
where
    Array: AsMut<[Item]>,
    GetKey: FnMut(&Item) -> Key,
    Key: Ord,
{
    array.as_mut().sort_by_key(get_key);
    array
}

/// Sort an array by a key extraction function (which would be called at most once per element) and return it.
///
/// This function calls [`slice::sort_by_cached_key`] under the hook.
///
/// [`slice::sort_by_cached_key`]: https://doc.rust-lang.org/std/primitive.slice.html#method.sort_by_cached_key
#[inline]
pub fn into_sorted_by_cached_key<Item, Array, Key, GetKey>(
    mut array: Array,
    get_key: GetKey,
) -> Array
where
    Array: AsMut<[Item]>,
    GetKey: FnMut(&Item) -> Key,
    Key: Ord,
{
    array.as_mut().sort_by_cached_key(get_key);
    array
}