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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

use super::functions::*;
use core::cmp::Ordering;

/// Utility methods to sort various types of arrays with a stable algorithm (requires allocation).
pub trait IntoSorted<Item>: crate::sealed::IsArray<Item> {
    /// 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
    fn into_sorted(self) -> Self
    where
        Item: Ord;

    /// 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
    fn into_sorted_by<Order>(self, order: Order) -> Self
    where
        Order: FnMut(&Item, &Item) -> Ordering;

    /// 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
    fn into_sorted_by_key<Key, GetKey>(self, get_key: GetKey) -> Self
    where
        GetKey: FnMut(&Item) -> Key,
        Key: Ord;

    /// Sort an array by a key extraction function 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
    fn into_sorted_by_cached_key<Key, GetKey>(self, get_key: GetKey) -> Self
    where
        GetKey: FnMut(&Item) -> Key,
        Key: Ord;
}

impl<Item, Array> IntoSorted<Item> for Array
where
    Array: AsMut<[Item]> + Sized,
{
    #[inline]
    fn into_sorted(self) -> Self
    where
        Item: Ord,
    {
        into_sorted(self)
    }

    #[inline]
    fn into_sorted_by<Order>(self, order: Order) -> Self
    where
        Order: FnMut(&Item, &Item) -> Ordering,
    {
        into_sorted_by(self, order)
    }

    #[inline]
    fn into_sorted_by_key<Key, GetKey>(self, get_key: GetKey) -> Self
    where
        GetKey: FnMut(&Item) -> Key,
        Key: Ord,
    {
        into_sorted_by_key(self, get_key)
    }

    #[inline]
    fn into_sorted_by_cached_key<Key, GetKey>(self, get_key: GetKey) -> Self
    where
        GetKey: FnMut(&Item) -> Key,
        Key: Ord,
    {
        into_sorted_by_cached_key(self, get_key)
    }
}