Enum DropPolicy

#[non_exhaustive]
pub enum DropPolicy {
    MayDropItems,
    MustNotDropItems,
}

Determines item dropping behavior when the container is dropped.

By default, the container will drop its items when it is dropped.

Examples

use std::alloc::Layout;

use opaque_pool::{DropPolicy, OpaquePool};

// The drop policy is set at pool creation time.
let layout = Layout::new::<u32>();
let pool = OpaquePool::builder()
    .layout(layout)
    .drop_policy(DropPolicy::MustNotDropItems)
    .build();

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MayDropItems

The container will drop its items when the container is dropped. This is the default.

MustNotDropItems

The container will panic if it still contains items when it is dropped.

This may be valuable if there are external requirements before the items can be dropped. For example, it may be known that unsafe code is used to create out of band references to the items, with items only removed after such references have been dropped.

Trait Implementations

impl Clone for DropPolicy

fn clone(&self) -> DropPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DropPolicy

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

Formats the value using the given formatter.

impl Default for DropPolicy

fn default() -> DropPolicy

Returns the “default value” for a type.

impl PartialEq for DropPolicy

fn eq(&self, other: &DropPolicy) -> bool

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

const 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 Copy for DropPolicy

impl Eq for DropPolicy

impl StructuralPartialEq for DropPolicy