Struct AllocationOptions

#[repr(C)]
pub struct AllocationOptions {
    pub allow_overcommit: bool,
    pub at_safepoint: bool,
    pub allow_oom_call: bool,
}

Allow specifying different behaviors with Allocator::alloc_with_options.

Fields

allow_overcommit: bool

Whether over-committing is allowed at this allocation site. Over-committing means the allocation is allowed to go beyond the current heap size. But it is not guaranteed to succeed.

The default is false.

Note that regardless of the value of allow_overcommit, the allocation may trigger GC if the GC trigger considers it needed.

at_safepoint: bool

Whether the allocation is at a safepoint.

The default is true.

If true, the allocation is allowed to block for GC.

If false, the allocation will immediately return a null address if the allocation cannot be satisfied without a GC.

allow_oom_call: bool

Whether the allocation is allowed to call Collection::out_of_memory.

The default is true.

If true, the allocation will call Collection::out_of_memory when out of memory and return null.

If fasle, the allocation will return null immediately when out of memory.

Implementations

impl AllocationOptions

pub(crate) fn is_default(&self) -> bool

Trait Implementations

impl Clone for AllocationOptions

fn clone(&self) -> AllocationOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AllocationOptions

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

Formats the value using the given formatter.

impl Default for AllocationOptions

The default value for AllocationOptions has the same semantics as calling Allocator::alloc directly.

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for AllocationOptions

fn eq(&self, other: &AllocationOptions) -> 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 Copy for AllocationOptions

impl Eq for AllocationOptions

impl StructuralPartialEq for AllocationOptions