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

use core::cmp::Ordering;

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

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

/// Sort an array by a key extraction function and return it.
///
/// This function calls [`slice::sort_unstable_by_key`] under the hook.
///
/// [`slice::sort_unstable_by_key`]: https://doc.rust-lang.org/std/primitive.slice.html#method.sort_unstable_by_key
#[inline]
pub fn into_sorted_unstable_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_unstable_by_key(get_key);
    array
}