Struct FlatDrop

pub struct FlatDrop<K>(/* private fields */)
where
    K: IntoOptionInner,
    K::Inner: Recursive<Container = K>;

If K is a container of a recursive type, such as Box<T> where T: Recursive, FlatDrop<K> behaves just like K, but with a custom Drop implementation. In this implementation, we gather the recursive parts of the object iteratively and drop them without recursion, avoiding stack overflows when dropping large recursive objects.

Safety

We keep the invariant that the inner object is always initialised, but will be dropped (exactly once) in the drop implementation.

Implementations

impl<K> FlatDrop<K>

where K: IntoOptionInner, K::Inner: Recursive<Container = K>,

pub const fn new(container: K) -> Self

pub fn into_inner(self) -> K

impl<T> FlatDrop<Box<T>>

where T: Recursive<Container = Box<T>>,

pub fn new_boxed(value: T) -> Self

impl<T> FlatDrop<Rc<T>>

where T: Recursive<Container = Rc<T>>,

pub fn new_rc(value: T) -> Self

impl<T> FlatDrop<Arc<T>>

where T: Recursive<Container = Arc<T>>,

pub fn new_arc(value: T) -> Self

Trait Implementations

impl<K, T> AsMut<T> for FlatDrop<K>

where T: ?Sized, K: IntoOptionInner + AsMut<T>, K::Inner: Recursive<Container = K>,

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

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

impl<K, T> AsRef<T> for FlatDrop<K>

where T: ?Sized, K: IntoOptionInner + AsRef<T>, K::Inner: Recursive<Container = K>,

fn as_ref(&self) -> &T

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

impl<K> Clone for FlatDrop<K>

where K: IntoOptionInner + Clone, K::Inner: Recursive<Container = K>,

fn clone(&self) -> FlatDrop<K>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K> Debug for FlatDrop<K>

where K: IntoOptionInner + Debug, K::Inner: Recursive<Container = K>,

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

Formats the value using the given formatter.

impl<K> Default for FlatDrop<K>

where K: IntoOptionInner + Default, K::Inner: Recursive<Container = K>,

fn default() -> FlatDrop<K>

Returns the “default value” for a type.

impl<K> Deref for FlatDrop<K>

where K: IntoOptionInner, K::Inner: Recursive<Container = K>,

type Target = K

The resulting type after dereferencing.

fn deref(&self) -> &K

Dereferences the value.

impl<K> DerefMut for FlatDrop<K>

where K: IntoOptionInner, K::Inner: Recursive<Container = K>,

fn deref_mut(&mut self) -> &mut K

Mutably dereferences the value.

impl<K> Display for FlatDrop<K>

where K: IntoOptionInner + Display, K::Inner: Recursive<Container = K>,

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

Formats the value using the given formatter.

impl<K> Drop for FlatDrop<K>

where K: IntoOptionInner, K::Inner: Recursive<Container = K>,

fn drop(&mut self)

Executes the destructor for this type.

impl<K> From<K> for FlatDrop<K>

where K: IntoOptionInner, K::Inner: Recursive<Container = K>,

fn from(value: K) -> Self

Converts to this type from the input type.

impl<K> Hash for FlatDrop<K>

where K: IntoOptionInner + Hash, K::Inner: Recursive<Container = K>,

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<K> Ord for FlatDrop<K>

where K: IntoOptionInner + Ord, K::Inner: Recursive<Container = K>,

fn cmp(&self, other: &FlatDrop<K>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<K> PartialEq for FlatDrop<K>

where K: IntoOptionInner + PartialEq, K::Inner: Recursive<Container = K>,

fn eq(&self, other: &FlatDrop<K>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<K> PartialOrd for FlatDrop<K>

where K: IntoOptionInner + PartialOrd, K::Inner: Recursive<Container = K>,

fn partial_cmp(&self, other: &FlatDrop<K>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<K> Eq for FlatDrop<K>

where K: IntoOptionInner + Eq, K::Inner: Recursive<Container = K>,

impl<K> StructuralPartialEq for FlatDrop<K>

where K: IntoOptionInner, K::Inner: Recursive<Container = K>,