Struct Required

pub struct Required<T>(/* private fields */);

Container requiring a field to have a value mandatory.

It’s similar to an Option, but panics on accessing to an absent underlying value. So, is not intended to be created directly in user code, but rather only used for marking types in struct fields, so this library machinery may kick in and take care of correct values creation without introducing any panics.

Accessing the underlying value, stored in this wrapper, is intended to be done via Deref and DerefMut in user code.

Implementations

impl<T> Required<T>

pub fn into_inner(self) -> T

Unwraps this Required Container returning the underlying value.

Panics

If this Container hasn’t been initialized properly, so contains no value.

Trait Implementations

impl<T: Clone> Clone for Required<T>

fn clone(&self) -> Required<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V> Container<V> for Required<V>

type Value = V

Type of values contained in this Container.

fn is_empty(&self) -> bool

Indicates whether this Container is empty (contains no values).

fn has(&self, _: &V) -> bool

Indicates whether the provided value is present in this Container.

fn replace(&mut self, val: V) -> Option<V>

Replaces the value contained in this Container with the provided one, and returns the replaced one, if any.

fn set(&mut self, value: V)

Sets the provided value into this Container, dropping the previous one, if any.

impl<T: Debug> Debug for Required<T>

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

Formats the value using the given formatter.

impl<T> Deref for Required<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Required<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, T> IntoIterator for &'a Required<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Once<&'a T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut Required<T>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = Once<&'a mut T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for Required<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = Once<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<V, K> TryApply<V, K, First> for Required<V>

where K: Kind + Single + ?Sized,

fn try_apply(&mut self, val: V) -> Result<()>

Applies the provided value to this field::Container.

impl<V, K> TryApply<V, K, Last> for Required<V>

where K: Kind + Single + ?Sized,

fn try_apply(&mut self, val: V) -> Result<()>

Applies the provided value to this field::Container.

impl<V, K> TryApply<V, K, Unique> for Required<V>

where for<'a> &'a V: IntoSpan, K: Kind + Single + ?Sized,

fn try_apply(&mut self, val: V) -> Result<()>

Applies the provided value to this field::Container.

impl<V, K, D> TryApplySelf<V, K, D> for Required<V>

where K: Kind + Single + ?Sized, D: Dedup + ?Sized, Self: TryApply<V, K, D>,

fn try_apply_self(&mut self, another: Self) -> Result<()>

Applies the value extracted from another field::Container to this field::Container.

impl<V> Validation<Provided> for Required<V>

fn validation(&self) -> Result<()>

Checks whether the validation Rule is satisfied.

impl<T: Copy> Copy for Required<T>