amplify::confinement

Struct Confined

Source
pub struct Confined<C: Collection, const MIN_LEN: usize, const MAX_LEN: usize>(/* private fields */);
Expand description

The confinement for the collection.

Implementations§

Source§

impl<'c, C, const MIN_LEN: usize, const MAX_LEN: usize> Confined<C, MIN_LEN, MAX_LEN>
where C: Collection + 'c, &'c mut C: IntoIterator<Item = &'c mut <C as Collection>::Item>,

Source

pub fn iter_mut(&'c mut self) -> <&'c mut C as IntoIterator>::IntoIter

Returns an iterator that allows modifying each value.

The iterator yields all items from start to end.

Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> Confined<C, MIN_LEN, MAX_LEN>
where C: KeyedCollection,

Source

pub fn values_mut(&mut self) -> impl Iterator<Item = &mut C::Value>

Returns an iterator that allows modifying each value for each key.

Source

pub fn keyed_values_mut( &mut self, ) -> impl Iterator<Item = (&C::Key, &mut C::Value)>

Returns an iterator that allows modifying each value for each key.

Source§

impl<C: Collection, const MIN_LEN: usize, const MAX_LEN: usize> Confined<C, MIN_LEN, MAX_LEN>

Source

pub fn from_checked(col: C) -> Self

Constructs confinement over collection which was already size-checked.

§Panics

Panics if the collection size doesn’t fit confinement type requirements.

Source

pub fn from_collection_unsafe(col: C) -> Self

👎Deprecated since 4.7.0: use from_checked
Source

pub fn try_from(col: C) -> Result<Self, Error>

Tries to construct a confinement over a collection. Fails if the number of items in the collection exceeds one of the confinement bounds.

Source

pub fn try_from_iter<I: IntoIterator<Item = C::Item>>( iter: I, ) -> Result<Self, Error>

Tries to construct a confinement with a collection of elements taken from an iterator. Fails if the number of items in the collection exceeds one of the confinement bounds.

Source

pub fn from_iter_checked<I: IntoIterator<Item = C::Item>>(iter: I) -> Self

Construct a confinement with a collection of elements taken from an iterator.

§Panics

Panics if the number of items in the collection exceeds one of the confinement bounds.

Source

pub fn from_iter_unsafe<I: IntoIterator<Item = C::Item>>(iter: I) -> Self

👎Deprecated since 4.7.0: use from_iter_checked
Source

pub fn as_inner(&self) -> &C

👎Deprecated since 4.7.0: use as_unconfined method

Returns inner collection type

Source

pub fn as_unconfined(&self) -> &C

Returns reference to the inner collection type.

Source

pub fn to_inner(&self) -> C
where C: Clone,

👎Deprecated since 4.7.0: use to_unconfined method

Clones inner collection type and returns it

Source

pub fn to_unconfined(&self) -> C
where C: Clone,

Clones inner collection and returns an unconfined version of it.

Source

pub fn into_inner(self) -> C

👎Deprecated since 4.7.0: use release method

Decomposes into the inner collection type

Source

pub fn push(&mut self, elem: C::Item) -> Result<(), Error>

Attempts to add a single element to the confined collection. Fails if the number of elements in the collection already maximal.

Source

pub fn extend<T: IntoIterator<Item = C::Item>>( &mut self, iter: T, ) -> Result<(), Error>

Attempts to add all elements from an iterator to the confined collection. Fails if the number of elements in the collection already maximal.

Source

pub fn unbox(self) -> C

👎Deprecated since 4.7.0: use release method

Removes confinement and returns the underlying collection.

Source

pub fn release(self) -> C

Releases underlying collection from the confinement.

Source§

impl<C, const MAX_LEN: usize> Confined<C, ZERO, MAX_LEN>
where C: Default + Collection,

Source

pub fn new() -> Self

Constructs a new confinement containing no elements.

Source

pub fn with_capacity(capacity: usize) -> Self

Constructs a new confinement containing no elements, but with a pre-allocated storage for the capacity of elements.

Source

pub fn clear(&mut self)

Removes all elements from the confined collection.

Source§

impl<C, const MAX_LEN: usize> Confined<C, ONE, MAX_LEN>
where C: Default + Collection,

Source

pub fn with(elem: C::Item) -> Self

Constructs a confinement with a collection made of a single required element.

Source§

impl<C, const MIN_LEN: usize> Confined<C, MIN_LEN, U8>
where C: Default + Collection,

Source

pub fn len_u8(&self) -> u8

Returns number of elements in the confined collection as u8. The confinement guarantees that the collection length can’t exceed u8::MAX.

Source§

impl<C, const MIN_LEN: usize> Confined<C, MIN_LEN, U16>
where C: Default + Collection,

Source

pub fn len_u16(&self) -> u16

Returns number of elements in the confined collection as u16. The confinement guarantees that the collection length can’t exceed u16::MAX.

Source§

impl<C, const MIN_LEN: usize> Confined<C, MIN_LEN, U24>
where C: Default + Collection,

Source

pub fn len_u24(&self) -> u24

Returns number of elements in the confined collection as u24. The confinement guarantees that the collection length can’t exceed u24::MAX.

Source§

impl<C, const MIN_LEN: usize> Confined<C, MIN_LEN, U32>
where C: Default + Collection,

Source

pub fn len_u32(&self) -> u32

Returns number of elements in the confined collection as u32. The confinement guarantees that the collection length can’t exceed u32::MAX.

Source§

impl<C: KeyedCollection, const MIN_LEN: usize, const MAX_LEN: usize> Confined<C, MIN_LEN, MAX_LEN>

Source

pub fn get_mut(&mut self, key: &C::Key) -> Option<&mut C::Value>

Gets mutable reference to an element of the collection.

Source

pub fn insert( &mut self, key: C::Key, value: C::Value, ) -> Result<Option<C::Value>, Error>

Inserts a new value into the confined collection under a given key. Fails if the collection already contains maximum number of elements allowed by the confinement.

Source

pub fn entry(&mut self, key: C::Key) -> Result<C::Entry<'_>, Error>

Gets the given key’s corresponding entry in the map for in-place manipulation. Errors if the collection entry is vacant and the collection has already reached maximal size of its confinement.

Source§

impl<C, const MAX_LEN: usize> Confined<C, ONE, MAX_LEN>

Source

pub fn with_key_value(key: C::Key, value: C::Value) -> Self

Constructs a confinement with a collection made of a single required key-value pair.

Source§

impl<const MAX_LEN: usize> Confined<String, ZERO, MAX_LEN>

Source

pub fn pop(&mut self) -> Option<char>

Removes the last character from a string and returns it, or None if it is empty.

Source§

impl<const MIN_LEN: usize, const MAX_LEN: usize> Confined<String, MIN_LEN, MAX_LEN>

Source

pub fn remove(&mut self, index: usize) -> Result<char, Error>

Removes a single character from the confined string, unless the string doesn’t shorten more than the confinement requirement. Errors otherwise.

Source§

impl<const MAX_LEN: usize> Confined<AsciiString, ZERO, MAX_LEN>

Source

pub fn pop(&mut self) -> Option<AsciiChar>

Removes the last character from a string and returns it, or None if it is empty.

Source§

impl<const MIN_LEN: usize, const MAX_LEN: usize> Confined<AsciiString, MIN_LEN, MAX_LEN>

Source

pub fn remove(&mut self, index: usize) -> Result<AsciiChar, Error>

Removes a single character from the confined string, unless the string doesn’t shorten more than the confinement requirement. Errors otherwise.

Source§

impl<T, const MIN_LEN: usize, const MAX_LEN: usize> Confined<Vec<T>, MIN_LEN, MAX_LEN>

Source

pub fn from_slice_checked(slice: &[T]) -> Self
where T: Clone,

Constructs confinement out of slice of items. Does allocation.

§Panics

Panics if the size of the slice doesn’t match the confinement type bounds.

Source

pub fn from_slice_unsafe(slice: &[T]) -> Self
where T: Clone,

👎Deprecated since 4.7.0: use from_slice_checked
Source

pub fn try_from_slice(slice: &[T]) -> Result<Self, Error>
where T: Clone,

Constructs confinement out of slice of items. Does allocation.

Source

pub fn as_slice(&self) -> &[T]

Returns slice representation of the vec.

Source

pub fn into_vec(self) -> Vec<T>

Converts into the inner unconfined vector.

Source

pub fn get_mut<I>(&mut self, index: I) -> Option<&mut I::Output>
where I: SliceIndex<[T]>,

Gets the mutable element of a vector

Source§

impl<T, const MAX_LEN: usize> Confined<Vec<T>, ZERO, MAX_LEN>

Source

pub fn pop(&mut self) -> Option<T>

Removes the last element from a vector and returns it, or None if it is empty.

Source§

impl<T, const MIN_LEN: usize, const MAX_LEN: usize> Confined<Vec<T>, MIN_LEN, MAX_LEN>

Source

pub fn remove(&mut self, index: usize) -> Result<T, Error>

Removes an element from the vector at a given index. Errors if the index exceeds the number of elements in the vector, of if the new vector length will be less than the confinement requirement. Returns the removed element otherwise.

Source

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the slice.

The iterator yields all items from start to end.

Source§

impl<T, const MIN_LEN: usize, const MAX_LEN: usize> Confined<VecDeque<T>, MIN_LEN, MAX_LEN>

Source

pub fn pop_front(&mut self) -> Option<T>

Removes the first element and returns it, or None if the deque is empty.

Source

pub fn pop_back(&mut self) -> Option<T>

Removes the last element and returns it, or None if the deque is empty.

Source§

impl<T, const MIN_LEN: usize, const MAX_LEN: usize> Confined<VecDeque<T>, MIN_LEN, MAX_LEN>

Source

pub fn push_front(&mut self, elem: T) -> Result<(), Error>

Prepends an element to the deque. Errors if the new collection length will not fit the confinement requirements.

Source

pub fn push_from(&mut self, elem: T) -> Result<(), Error>

👎Deprecated since 4.7.1: use push_front
Source

pub fn push_back(&mut self, elem: T) -> Result<(), Error>

Appends an element to the deque. Errors if the new collection length will not fit the confinement requirements.

Source

pub fn remove(&mut self, index: usize) -> Result<T, Error>

Removes an element from the deque at a given index. Errors if the index exceeds the number of elements in the deque, of if the new deque length will be less than the confinement requirement. Returns the removed element otherwise.

Source

pub fn drain<R: RangeBounds<usize>>(&mut self, range: R) -> Drain<'_, T>

Removes the specified range from the deque in bulk, returning all removed elements as an iterator. If the iterator is dropped before being fully consumed, it drops the remaining removed elements.

The returned iterator keeps a mutable borrow on the queue to optimize its implementation.

§Panics

Panics if the starting point is greater than the end point or if the end point is greater than the length of the deque.

§Leaking

If the returned iterator goes out of scope without being dropped (due to [mem::forget], for example), the deque may have lost and leaked elements arbitrarily, including elements outside the range.

Source

pub fn truncate(&mut self, len: usize)

Shortens the deque, keeping the first len elements and dropping the rest.

If len is greater or equal to the deque’s current length, this has no effect.

Source§

impl<T: Hash + Eq, const MIN_LEN: usize, const MAX_LEN: usize> Confined<HashSet<T>, MIN_LEN, MAX_LEN>

Source

pub fn remove(&mut self, elem: &T) -> Result<bool, Error>

Removes an element from the set. Errors if the index exceeds the number of elements in the set, of if the new collection length will be less than the confinement requirement. Returns if the element was present in the set.

Source

pub fn take(&mut self, elem: &T) -> Result<Option<T>, Error>

Removes an element from the set. Errors if the index exceeds the number of elements in the set, of if the new collection length will be less than the confinement requirement. Returns the removed element otherwise.

Source§

impl<T: Ord, const MIN_LEN: usize, const MAX_LEN: usize> Confined<BTreeSet<T>, MIN_LEN, MAX_LEN>

Source

pub fn remove(&mut self, elem: &T) -> Result<bool, Error>

Removes an element from the set. Errors if the index exceeds the number of elements in the set, of if the new collection length will be less than the confinement requirement. Returns if the element was present in the set.

Source

pub fn take(&mut self, elem: &T) -> Result<Option<T>, Error>

Removes an element from the set. Errors if the index exceeds the number of elements in the set, of if the new collection length will be less than the confinement requirement. Returns the removed element otherwise.

Source§

impl<K: Hash + Eq, V, const MIN_LEN: usize, const MAX_LEN: usize> Confined<HashMap<K, V>, MIN_LEN, MAX_LEN>

Source

pub fn remove(&mut self, key: &K) -> Result<Option<V>, Error>

Removes an element from the map. Errors if the index exceeds the number of elements in the map, of if the new collection length will be less than the confinement requirement. Returns the removed value otherwise.

Source

pub fn into_keys(self) -> IntoKeys<K, V>

Creates a consuming iterator visiting all the keys in arbitrary order. The map cannot be used after calling this. The iterator element type is K.

Source

pub fn into_values(self) -> IntoValues<K, V>

Creates a consuming iterator visiting all the values in arbitrary order. The map cannot be used after calling this. The iterator element type is V.

Source§

impl<K: Ord + Hash, V, const MIN_LEN: usize, const MAX_LEN: usize> Confined<BTreeMap<K, V>, MIN_LEN, MAX_LEN>

Source

pub fn remove(&mut self, key: &K) -> Result<Option<V>, Error>

Removes an element from the map. Errors if the index exceeds the number of elements in the map, of if the new collection length will be less than the confinement requirement. Returns the removed value otherwise.

Source

pub fn into_keys(self) -> IntoKeys<K, V>

Creates a consuming iterator visiting all the keys in arbitrary order. The map cannot be used after calling this. The iterator element type is K.

Source

pub fn into_values(self) -> IntoValues<K, V>

Creates a consuming iterator visiting all the values in arbitrary order. The map cannot be used after calling this. The iterator element type is V.

Trait Implementations§

Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> AsMut<[<C as Collection>::Item]> for Confined<C, MIN_LEN, MAX_LEN>
where C: Collection + AsMut<[C::Item]>,

Source§

fn as_mut(&mut self) -> &mut [C::Item]

Converts this type into a mutable reference of the (usually inferred) input type.
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> AsRef<[<C as Collection>::Item]> for Confined<C, MIN_LEN, MAX_LEN>
where C: Collection + AsRef<[C::Item]>,

Source§

fn as_ref(&self) -> &[C::Item]

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> Borrow<[<C as Collection>::Item]> for Confined<C, MIN_LEN, MAX_LEN>
where C: Collection + Borrow<[C::Item]>,

Source§

fn borrow(&self) -> &[C::Item]

Immutably borrows from an owned value. Read more
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> BorrowMut<[<C as Collection>::Item]> for Confined<C, MIN_LEN, MAX_LEN>
where C: Collection + BorrowMut<[C::Item]>,

Source§

fn borrow_mut(&mut self) -> &mut [C::Item]

Mutably borrows from an owned value. Read more
Source§

impl<C: Clone + Collection, const MIN_LEN: usize, const MAX_LEN: usize> Clone for Confined<C, MIN_LEN, MAX_LEN>

Source§

fn clone(&self) -> Confined<C, MIN_LEN, MAX_LEN>

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<C: Debug + Collection, const MIN_LEN: usize, const MAX_LEN: usize> Debug for Confined<C, MIN_LEN, MAX_LEN>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<C, const MAX_LEN: usize> Default for Confined<C, ZERO, MAX_LEN>
where C: Default + Collection,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<C: Collection, const MIN_LEN: usize, const MAX_LEN: usize> Deref for Confined<C, MIN_LEN, MAX_LEN>

Source§

type Target = C

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> Display for Confined<C, MIN_LEN, MAX_LEN>
where C: Display + Collection,

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<const MIN_LEN: usize, const MAX_LEN: usize> FromHex for Confined<Vec<u8>, MIN_LEN, MAX_LEN>

Source§

fn from_byte_iter<I>(iter: I) -> Result<Self, Error>

Produce an object from a byte iterator
Source§

fn from_hex(s: &str) -> Result<Self, Error>

Produce an object from a hex string
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> FromStr for Confined<C, MIN_LEN, MAX_LEN>
where C: FromStr + Collection,

Source§

type Err = <C as FromStr>::Err

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl<C: Hash + Collection, const MIN_LEN: usize, const MAX_LEN: usize> Hash for Confined<C, MIN_LEN, MAX_LEN>

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> Index<Range<usize>> for Confined<C, MIN_LEN, MAX_LEN>
where C: Index<Range<usize>, Output = [C::Item]> + Collection,

Source§

type Output = [<C as Collection>::Item]

The returned type after indexing.
Source§

fn index(&self, index: Range<usize>) -> &Self::Output

Performs the indexing (container[index]) operation. Read more
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> Index<RangeFrom<usize>> for Confined<C, MIN_LEN, MAX_LEN>
where C: Index<RangeFrom<usize>, Output = [C::Item]> + Collection,

Source§

type Output = [<C as Collection>::Item]

The returned type after indexing.
Source§

fn index(&self, index: RangeFrom<usize>) -> &Self::Output

Performs the indexing (container[index]) operation. Read more
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> Index<RangeFull> for Confined<C, MIN_LEN, MAX_LEN>
where C: Index<RangeFull, Output = [C::Item]> + Collection,

Source§

type Output = [<C as Collection>::Item]

The returned type after indexing.
Source§

fn index(&self, index: RangeFull) -> &Self::Output

Performs the indexing (container[index]) operation. Read more
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> Index<RangeInclusive<usize>> for Confined<C, MIN_LEN, MAX_LEN>
where C: Index<RangeInclusive<usize>, Output = [C::Item]> + Collection,

Source§

type Output = [<C as Collection>::Item]

The returned type after indexing.
Source§

fn index(&self, index: RangeInclusive<usize>) -> &Self::Output

Performs the indexing (container[index]) operation. Read more
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> Index<RangeTo<usize>> for Confined<C, MIN_LEN, MAX_LEN>
where C: Index<RangeTo<usize>, Output = [C::Item]> + Collection,

Source§

type Output = [<C as Collection>::Item]

The returned type after indexing.
Source§

fn index(&self, index: RangeTo<usize>) -> &Self::Output

Performs the indexing (container[index]) operation. Read more
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> Index<RangeToInclusive<usize>> for Confined<C, MIN_LEN, MAX_LEN>
where C: Index<RangeToInclusive<usize>, Output = [C::Item]> + Collection,

Source§

type Output = [<C as Collection>::Item]

The returned type after indexing.
Source§

fn index(&self, index: RangeToInclusive<usize>) -> &Self::Output

Performs the indexing (container[index]) operation. Read more
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> Index<usize> for Confined<C, MIN_LEN, MAX_LEN>
where C: Index<usize, Output = C::Item> + Collection,

Source§

type Output = <C as Collection>::Item

The returned type after indexing.
Source§

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation. Read more
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> IndexMut<Range<usize>> for Confined<C, MIN_LEN, MAX_LEN>
where C: IndexMut<Range<usize>, Output = [C::Item]> + Collection,

Source§

fn index_mut(&mut self, index: Range<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation. Read more
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> IndexMut<RangeFrom<usize>> for Confined<C, MIN_LEN, MAX_LEN>
where C: IndexMut<RangeFrom<usize>, Output = [C::Item]> + Collection,

Source§

fn index_mut(&mut self, index: RangeFrom<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation. Read more
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> IndexMut<RangeFull> for Confined<C, MIN_LEN, MAX_LEN>
where C: IndexMut<RangeFull, Output = [C::Item]> + Collection,

Source§

fn index_mut(&mut self, index: RangeFull) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation. Read more
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> IndexMut<RangeInclusive<usize>> for Confined<C, MIN_LEN, MAX_LEN>
where C: IndexMut<RangeInclusive<usize>, Output = [C::Item]> + Collection,

Source§

fn index_mut(&mut self, index: RangeInclusive<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation. Read more
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> IndexMut<RangeTo<usize>> for Confined<C, MIN_LEN, MAX_LEN>
where C: IndexMut<RangeTo<usize>, Output = [C::Item]> + Collection,

Source§

fn index_mut(&mut self, index: RangeTo<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation. Read more
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> IndexMut<RangeToInclusive<usize>> for Confined<C, MIN_LEN, MAX_LEN>
where C: IndexMut<RangeToInclusive<usize>, Output = [C::Item]> + Collection,

Source§

fn index_mut(&mut self, index: RangeToInclusive<usize>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation. Read more
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> IndexMut<usize> for Confined<C, MIN_LEN, MAX_LEN>
where C: IndexMut<usize, Output = C::Item> + Collection,

Source§

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation. Read more
Source§

impl<'c, C: Collection, const MIN_LEN: usize, const MAX_LEN: usize> IntoIterator for &'c Confined<C, MIN_LEN, MAX_LEN>

Source§

type Item = <&'c C as IntoIterator>::Item

The type of the elements being iterated over.
Source§

type IntoIter = <&'c C as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<'c, C: Collection, const MIN_LEN: usize, const MAX_LEN: usize> IntoIterator for &'c mut Confined<C, MIN_LEN, MAX_LEN>

Source§

type Item = <&'c mut C as IntoIterator>::Item

The type of the elements being iterated over.
Source§

type IntoIter = <&'c mut C as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> IntoIterator for Confined<C, MIN_LEN, MAX_LEN>

Source§

type Item = <C as IntoIterator>::Item

The type of the elements being iterated over.
Source§

type IntoIter = <C as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<const MIN_LEN: usize, const MAX_LEN: usize> LowerHex for Confined<Vec<u8>, MIN_LEN, MAX_LEN>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<C: Ord + Collection, const MIN_LEN: usize, const MAX_LEN: usize> Ord for Confined<C, MIN_LEN, MAX_LEN>

Source§

fn cmp(&self, other: &Confined<C, MIN_LEN, MAX_LEN>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<C: PartialEq + Collection, const MIN_LEN: usize, const MAX_LEN: usize> PartialEq for Confined<C, MIN_LEN, MAX_LEN>

Source§

fn eq(&self, other: &Confined<C, MIN_LEN, MAX_LEN>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<C: PartialOrd + Collection, const MIN_LEN: usize, const MAX_LEN: usize> PartialOrd for Confined<C, MIN_LEN, MAX_LEN>

Source§

fn partial_cmp(&self, other: &Confined<C, MIN_LEN, MAX_LEN>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<const MIN_LEN: usize, const MAX_LEN: usize> TryFrom<&str> for Confined<AsciiString, MIN_LEN, MAX_LEN>

Source§

type Error = AsciiError

The type returned in the event of a conversion error.
Source§

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl<const MIN_LEN: usize, const MAX_LEN: usize> TryFrom<&str> for Confined<String, MIN_LEN, MAX_LEN>

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl<const MIN_LEN: usize, const MAX_LEN: usize> UpperHex for Confined<Vec<u8>, MIN_LEN, MAX_LEN>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<const MAX_LEN: usize> Write for Confined<Vec<u8>, ZERO, MAX_LEN>

Source§

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written. Read more
Source§

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
1.36.0 · Source§

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers. Read more
Source§

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Writer has an efficient write_vectored implementation. Read more
1.0.0 · Source§

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer. Read more
Source§

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)
Attempts to write multiple buffers into this writer. Read more
1.0.0 · Source§

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adapter for this instance of Write. Read more
Source§

impl<C: Eq + Collection, const MIN_LEN: usize, const MAX_LEN: usize> Eq for Confined<C, MIN_LEN, MAX_LEN>

Source§

impl<C: Collection, const MIN_LEN: usize, const MAX_LEN: usize> StructuralPartialEq for Confined<C, MIN_LEN, MAX_LEN>

Auto Trait Implementations§

§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> Freeze for Confined<C, MIN_LEN, MAX_LEN>
where C: Freeze,

§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> RefUnwindSafe for Confined<C, MIN_LEN, MAX_LEN>
where C: RefUnwindSafe,

§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> Send for Confined<C, MIN_LEN, MAX_LEN>
where C: Send,

§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> Sync for Confined<C, MIN_LEN, MAX_LEN>
where C: Sync,

§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> Unpin for Confined<C, MIN_LEN, MAX_LEN>
where C: Unpin,

§

impl<C, const MIN_LEN: usize, const MAX_LEN: usize> UnwindSafe for Confined<C, MIN_LEN, MAX_LEN>
where C: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToHex for T
where T: LowerHex,

Source§

fn to_hex(&self) -> String

Outputs the hash in hexadecimal form

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.