Struct starlark::values::FrozenHeapRef

pub struct FrozenHeapRef(/* private fields */);

A reference to a FrozenHeap that keeps alive all values on the underlying heap. Note that the Hash is consistent for a single FrozenHeapRef, but non-deterministic across executions and distinct but observably identical FrozenHeapRef values.

Implementations

impl FrozenHeapRef

pub fn allocated_bytes(&self) -> usize

Number of bytes allocated on this heap, not including any memory allocated outside of the starlark heap.

pub fn available_bytes(&self) -> usize

Number of bytes allocated by the heap but not filled. Note that these bytes will never be filled as no further allocations can be made on this heap (it has been sealed).

pub fn allocated_summary(&self) -> HeapSummary

Obtain a summary of how much memory is currently allocated by this heap. Doesn’t include the heaps it keeps alive by reference.

Trait Implementations

impl Allocative for FrozenHeapRef

fn visit<'allocative_a, 'allocative_b: 'allocative_a>( &self, visitor: &'allocative_a mut Visitor<'allocative_b> )

impl Clone for FrozenHeapRef

fn clone(&self) -> FrozenHeapRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrozenHeapRef

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

Formats the value using the given formatter.

impl Default for FrozenHeapRef

fn default() -> FrozenHeapRef

Returns the “default value” for a type.

impl Dupe for FrozenHeapRef

fn dupe(&self) -> Self

impl Hash for FrozenHeapRef

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 PartialEq for FrozenHeapRef

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for FrozenHeapRef