Struct starlark::values::FrozenHeap

pub struct FrozenHeap { /* private fields */ }

A heap on which FrozenValues can be allocated. Can be kept alive by a FrozenHeapRef.

Implementations

impl FrozenHeap

pub fn new() -> Self

Create a new FrozenHeap.

pub fn into_ref(self) -> FrozenHeapRef

After all values have been allocated, convert the FrozenHeap into a FrozenHeapRef which can be cloned, shared between threads, and ensures the underlying values allocated on the FrozenHeap remain valid.

pub fn add_reference(&self, heap: &FrozenHeapRef)

Keep the argument FrozenHeapRef alive as long as this FrozenHeap is kept alive. Used if a FrozenValue in this heap points at values in another FrozenHeap.

pub fn alloc_str(&self, x: &str) -> FrozenStringValue

Allocate a string on this heap. Be careful about the warnings around FrozenValue.

pub fn alloc_str_hashed(&self, x: Hashed<&str>) -> FrozenStringValue

Allocate prehashed string.

pub fn alloc_simple<T: StarlarkValue<'static> + Send + Sync>( &self, val: T ) -> FrozenValue

Allocate a simple StarlarkValue on this heap.

Simple value is any starlark value which:

• bound by 'static lifetime (in particular, it cannot contain references to other Values)
• is not special builtin (e.g. None)

pub fn alloc_any_display_from_debug<T: Debug + Send + Sync>( &self, value: T ) -> FrozenRef<'static, T>

Allocate any value, use Debug implementation for Display.

pub fn alloc<T: AllocFrozenValue>(&self, val: T) -> FrozenValue

Allocate a new value on a FrozenHeap.

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 yet filled.

pub fn allocated_summary(&self) -> HeapSummary

Obtain a summary of how much memory is currently allocated by this heap.

Trait Implementations

impl Debug for FrozenHeap

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

Formats the value using the given formatter.

impl Default for FrozenHeap

fn default() -> FrozenHeap

Returns the “default value” for a type.