Trait BumpAllocatorSettings 

pub trait BumpAllocatorSettings: Sealed {
    type MinimumAlignment: SupportedMinimumAlignment;
    type Up: Boolean;
    type GuaranteedAllocated: Boolean;
    type Claimable: Boolean;
    type Deallocates: Boolean;
    type Shrinks: Boolean;
    type WithMinimumAlignment<const NEW_MIN_ALIGN: usize>: BumpAllocatorSettings<MinimumAlignment = MinimumAlignment<NEW_MIN_ALIGN>, Up = Self::Up, GuaranteedAllocated = Self::GuaranteedAllocated, Claimable = Self::Claimable, Deallocates = Self::Deallocates, Shrinks = Self::Shrinks>
       where MinimumAlignment<NEW_MIN_ALIGN>: SupportedMinimumAlignment;
    type WithUp<const VALUE: bool>: BumpAllocatorSettings<MinimumAlignment = Self::MinimumAlignment, Up = Bool<VALUE>, GuaranteedAllocated = Self::GuaranteedAllocated, Claimable = Self::Claimable, Deallocates = Self::Deallocates, Shrinks = Self::Shrinks>;
    type WithGuaranteedAllocated<const VALUE: bool>: BumpAllocatorSettings<MinimumAlignment = Self::MinimumAlignment, Up = Self::Up, GuaranteedAllocated = Bool<VALUE>, Claimable = Self::Claimable, Deallocates = Self::Deallocates, Shrinks = Self::Shrinks>;
    type WithClaimable<const VALUE: bool>: BumpAllocatorSettings<MinimumAlignment = Self::MinimumAlignment, Up = Self::Up, GuaranteedAllocated = Self::GuaranteedAllocated, Claimable = Bool<VALUE>, Deallocates = Self::Deallocates, Shrinks = Self::Shrinks>;
    type WithDeallocates<const VALUE: bool>: BumpAllocatorSettings<MinimumAlignment = Self::MinimumAlignment, Up = Self::Up, GuaranteedAllocated = Self::GuaranteedAllocated, Claimable = Self::Claimable, Deallocates = Bool<VALUE>, Shrinks = Self::Shrinks>;
    type WithShrinks<const VALUE: bool>: BumpAllocatorSettings<MinimumAlignment = Self::MinimumAlignment, Up = Self::Up, GuaranteedAllocated = Self::GuaranteedAllocated, Claimable = Self::Claimable, Deallocates = Self::Deallocates, Shrinks = Bool<VALUE>>;
    type WithMinimumChunkSize<const VALUE: usize>: BumpAllocatorSettings<MinimumAlignment = Self::MinimumAlignment, Up = Self::Up, GuaranteedAllocated = Self::GuaranteedAllocated, Claimable = Self::Claimable, Deallocates = Self::Deallocates, Shrinks = Self::Shrinks>;

    const MINIMUM_CHUNK_SIZE: usize;
    const MIN_ALIGN: usize = <Self::MinimumAlignment>::VALUE;
    const UP: bool = <Self::Up>::VALUE;
    const GUARANTEED_ALLOCATED: bool = <Self::GuaranteedAllocated>::VALUE;
    const CLAIMABLE: bool = <Self::Claimable>::VALUE;
    const DEALLOCATES: bool = <Self::Deallocates>::VALUE;
    const SHRINKS: bool = <Self::Shrinks>::VALUE;
}

The trait powering bump allocator configuration.

Read the module documentation to learn about the settings.

The setting values are provided as associated constants.

Additionally they are provided as types so they can be used in equality bounds like this:

S: BumpAllocatorSettings<GuaranteedAllocated = True>

Doing the same with associated constants is not (yet) possible:

// won't compile on stable
S: BumpAllocatorSettings<GUARANTEED_ALLOCATED = true>

In the future this trait could be simplified when the following features are stabilized:

• generic_const_exprs
• associated_const_equality

Required Associated Constants

const MINIMUM_CHUNK_SIZE: usize

The minimum size for bump allocation chunk.

Provided Associated Constants

const MIN_ALIGN: usize = <Self::MinimumAlignment>::VALUE

The minimum alignment.

const UP: bool = <Self::Up>::VALUE

The bump direction.

const GUARANTEED_ALLOCATED: bool = <Self::GuaranteedAllocated>::VALUE

Whether the allocator is guaranteed to have a chunk allocated and thus is allowed to create scopes.

const CLAIMABLE: bool = <Self::Claimable>::VALUE

Whether the allocator can be claimed.

const DEALLOCATES: bool = <Self::Deallocates>::VALUE

Whether the allocator tries to free allocations.

const SHRINKS: bool = <Self::Shrinks>::VALUE

Whether the allocator tries to shrink allocations.

Required Associated Types

type MinimumAlignment: SupportedMinimumAlignment

The minimum alignment.

type Up: Boolean

The bump direction.

type GuaranteedAllocated: Boolean

Whether the allocator is guaranteed to have a chunk allocated and thus is allowed to create scopes.

type Claimable: Boolean

Whether the allocator can be claimed.

type Deallocates: Boolean

Whether the allocator tries to free allocations.

type Shrinks: Boolean

Whether the allocator tries to shrink allocations.

type WithMinimumAlignment<const NEW_MIN_ALIGN: usize>: BumpAllocatorSettings<MinimumAlignment = MinimumAlignment<NEW_MIN_ALIGN>, Up = Self::Up, GuaranteedAllocated = Self::GuaranteedAllocated, Claimable = Self::Claimable, Deallocates = Self::Deallocates, Shrinks = Self::Shrinks> where MinimumAlignment<NEW_MIN_ALIGN>: SupportedMinimumAlignment

Changes the minimum alignment.

type WithUp<const VALUE: bool>: BumpAllocatorSettings<MinimumAlignment = Self::MinimumAlignment, Up = Bool<VALUE>, GuaranteedAllocated = Self::GuaranteedAllocated, Claimable = Self::Claimable, Deallocates = Self::Deallocates, Shrinks = Self::Shrinks>

Changes the bump direction.

type WithGuaranteedAllocated<const VALUE: bool>: BumpAllocatorSettings<MinimumAlignment = Self::MinimumAlignment, Up = Self::Up, GuaranteedAllocated = Bool<VALUE>, Claimable = Self::Claimable, Deallocates = Self::Deallocates, Shrinks = Self::Shrinks>

Changes whether the allocator is guaranteed to have a chunk allocated and thus is allowed to create scopes.

type WithClaimable<const VALUE: bool>: BumpAllocatorSettings<MinimumAlignment = Self::MinimumAlignment, Up = Self::Up, GuaranteedAllocated = Self::GuaranteedAllocated, Claimable = Bool<VALUE>, Deallocates = Self::Deallocates, Shrinks = Self::Shrinks>

Changes whether the allocator can be claimed.

type WithDeallocates<const VALUE: bool>: BumpAllocatorSettings<MinimumAlignment = Self::MinimumAlignment, Up = Self::Up, GuaranteedAllocated = Self::GuaranteedAllocated, Claimable = Self::Claimable, Deallocates = Bool<VALUE>, Shrinks = Self::Shrinks>

Changes whether the allocator tries to free allocations.

type WithShrinks<const VALUE: bool>: BumpAllocatorSettings<MinimumAlignment = Self::MinimumAlignment, Up = Self::Up, GuaranteedAllocated = Self::GuaranteedAllocated, Claimable = Self::Claimable, Deallocates = Self::Deallocates, Shrinks = Bool<VALUE>>

Changes whether the allocator tries to shrink allocations.

type WithMinimumChunkSize<const VALUE: usize>: BumpAllocatorSettings<MinimumAlignment = Self::MinimumAlignment, Up = Self::Up, GuaranteedAllocated = Self::GuaranteedAllocated, Claimable = Self::Claimable, Deallocates = Self::Deallocates, Shrinks = Self::Shrinks>

Changes the minimum chunk size.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<const MIN_ALIGN: usize, const UP: bool, const GUARANTEED_ALLOCATED: bool, const CLAIMABLE: bool, const DEALLOCATES: bool, const SHRINKS: bool, const MINIMUM_CHUNK_SIZE: usize> BumpAllocatorSettings for BumpSettings<MIN_ALIGN, UP, GUARANTEED_ALLOCATED, CLAIMABLE, DEALLOCATES, SHRINKS, MINIMUM_CHUNK_SIZE>

where MinimumAlignment<MIN_ALIGN>: SupportedMinimumAlignment,

const MINIMUM_CHUNK_SIZE: usize = MINIMUM_CHUNK_SIZE

type MinimumAlignment = MinimumAlignment<MIN_ALIGN>

type Up = Bool<UP>

type GuaranteedAllocated = Bool<GUARANTEED_ALLOCATED>

type Claimable = Bool<CLAIMABLE>

type Deallocates = Bool<DEALLOCATES>

type Shrinks = Bool<SHRINKS>

type WithMinimumAlignment<const VALUE: usize> = BumpSettings<VALUE, UP, GUARANTEED_ALLOCATED, CLAIMABLE, DEALLOCATES, SHRINKS, MINIMUM_CHUNK_SIZE> where MinimumAlignment<VALUE>: SupportedMinimumAlignment

type WithUp<const VALUE: bool> = BumpSettings<MIN_ALIGN, VALUE, GUARANTEED_ALLOCATED, CLAIMABLE, DEALLOCATES, SHRINKS, MINIMUM_CHUNK_SIZE>

type WithGuaranteedAllocated<const VALUE: bool> = BumpSettings<MIN_ALIGN, UP, VALUE, CLAIMABLE, DEALLOCATES, SHRINKS, MINIMUM_CHUNK_SIZE>

type WithClaimable<const VALUE: bool> = BumpSettings<MIN_ALIGN, UP, GUARANTEED_ALLOCATED, VALUE, DEALLOCATES, SHRINKS, MINIMUM_CHUNK_SIZE>

type WithDeallocates<const VALUE: bool> = BumpSettings<MIN_ALIGN, UP, GUARANTEED_ALLOCATED, CLAIMABLE, VALUE, SHRINKS, MINIMUM_CHUNK_SIZE>

type WithShrinks<const VALUE: bool> = BumpSettings<MIN_ALIGN, UP, GUARANTEED_ALLOCATED, CLAIMABLE, DEALLOCATES, VALUE, MINIMUM_CHUNK_SIZE>

type WithMinimumChunkSize<const VALUE: usize> = BumpSettings<MIN_ALIGN, UP, GUARANTEED_ALLOCATED, CLAIMABLE, DEALLOCATES, SHRINKS, VALUE>