cl-aux 4.0.0

Provides elements that describe collections
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185

use crate::SingleItemStorage;
#[cfg(feature = "alloc")]
use alloc::vec::Vec;

/// See [GetMut::get_mut] for more information.
pub trait GetMut {
  /// Error
  type Error;
  /// Input
  type Input;
  /// Output
  type Output<'output>
  where
    Self: 'output;

  /// Returns an mutable inner reference of a derived element.
  fn get_mut(&mut self, input: Self::Input) -> Result<Self::Output<'_>, Self::Error>;
}

impl<T> GetMut for &mut T
where
  T: GetMut,
{
  type Error = T::Error;
  type Input = T::Input;
  type Output<'output> = T::Output<'output>
  where
    Self: 'output;

  #[inline]
  fn get_mut(&mut self, input: Self::Input) -> Result<Self::Output<'_>, Self::Error> {
    (*self).get_mut(input)
  }
}

/// ```rust
/// let mut structure = cl_aux::doc_tests::single_item_storage();
/// assert_eq!(cl_aux::GetMut::get_mut(&mut structure, 0), Ok(&mut 1));
/// ```
impl<T> GetMut for SingleItemStorage<T> {
  type Error = crate::Error;
  type Input = usize;
  type Output<'output> = &'output mut T
  where
    Self: 'output;

  #[inline]
  fn get_mut(&mut self, input: Self::Input) -> Result<Self::Output<'_>, Self::Error> {
    _get_mut!(self.as_mut(), input)
  }
}

/// ```rust
/// let mut structure = cl_aux::doc_tests::array();
/// assert_eq!(cl_aux::GetMut::get_mut(&mut structure, 0), Ok(&mut 1));
/// ```
impl<T, const N: usize> GetMut for [T; N] {
  type Error = crate::Error;
  type Input = usize;
  type Output<'output> = &'output mut T
  where
    Self: 'output;

  #[inline]
  fn get_mut(&mut self, input: Self::Input) -> Result<Self::Output<'_>, Self::Error> {
    _get_mut!(self.as_mut(), input)
  }
}

/// ```rust
/// let mut structure = cl_aux::doc_tests::slice_mut!();
/// assert_eq!(cl_aux::GetMut::get_mut(&mut structure, 0), Ok(&mut 1));
/// ```
impl<T> GetMut for &'_ mut [T] {
  type Error = crate::Error;
  type Input = usize;
  type Output<'output> = &'output mut T
  where
    Self: 'output;

  #[inline]
  fn get_mut(&mut self, input: Self::Input) -> Result<Self::Output<'_>, Self::Error> {
    _get_mut!(self.as_mut(), input)
  }
}

/// ```rust
/// let mut structure = cl_aux::doc_tests::vec();
/// assert_eq!(cl_aux::GetMut::get_mut(&mut structure, 0), Ok(&mut 1));
/// ```
#[cfg(feature = "alloc")]
impl<T> GetMut for Vec<T> {
  type Error = crate::Error;
  type Input = usize;
  type Output<'output> = &'output mut T
  where
    Self: 'output;

  #[inline]
  fn get_mut(&mut self, input: Self::Input) -> Result<Self::Output<'_>, Self::Error> {
    _get_mut!(self.as_mut_slice(), input)
  }
}

/// ```rust
/// let mut structure = cl_aux::doc_tests::array_vec();
/// assert_eq!(cl_aux::GetMut::get_mut(&mut structure, 0), Ok(&mut 1));
/// ```
#[cfg(feature = "arrayvec")]
impl<T, const N: usize> GetMut for arrayvec::ArrayVec<T, N> {
  type Error = crate::Error;
  type Input = usize;
  type Output<'output> = &'output mut T
  where
    Self: 'output;

  #[inline]
  fn get_mut(&mut self, input: Self::Input) -> Result<Self::Output<'_>, Self::Error> {
    _get_mut!(self.as_mut(), input)
  }
}

/// ```rust
/// let mut structure = cl_aux::doc_tests::small_vec();
/// assert_eq!(cl_aux::GetMut::get_mut(&mut structure, 0), Ok(&mut 1));
/// ```
#[cfg(feature = "smallvec")]
impl<A> GetMut for smallvec::SmallVec<A>
where
  A: smallvec::Array,
{
  type Error = crate::Error;
  type Input = usize;
  type Output<'output> = &'output mut A::Item
  where
    Self: 'output;

  #[inline]
  fn get_mut(&mut self, input: Self::Input) -> Result<Self::Output<'_>, Self::Error> {
    _get_mut!(self.as_mut(), input)
  }
}

/// ```rust
/// let mut structure = cl_aux::doc_tests::tiny_vec_array_vec();
/// assert_eq!(cl_aux::GetMut::get_mut(&mut structure, 0), Ok(&mut 1));
/// ```
#[cfg(feature = "tinyvec")]
impl<A> GetMut for tinyvec::ArrayVec<A>
where
  A: tinyvec::Array,
{
  type Error = crate::Error;
  type Input = usize;
  type Output<'output> = &'output mut A::Item
  where
    Self: 'output;

  #[inline]
  fn get_mut(&mut self, input: Self::Input) -> Result<Self::Output<'_>, Self::Error> {
    _get_mut!(self.as_mut(), input)
  }
}

/// ```rust
/// let mut structure = cl_aux::doc_tests::tiny_vec_tiny_vec();
/// assert_eq!(cl_aux::GetMut::get_mut(&mut structure, 0), Ok(&mut 1));
/// ```
#[cfg(all(feature = "alloc", feature = "tinyvec"))]
impl<A> GetMut for tinyvec::TinyVec<A>
where
  A: tinyvec::Array,
  A::Item: Default,
{
  type Error = crate::Error;
  type Input = usize;
  type Output<'output> = &'output mut A::Item
  where
    Self: 'output;

  #[inline]
  fn get_mut(&mut self, input: Self::Input) -> Result<Self::Output<'_>, Self::Error> {
    _get_mut!(self.as_mut(), input)
  }
}