Struct starlark::values::Heap

pub struct Heap { /* private fields */ }

A heap on which Values can be allocated. The values will be annotated with the heap lifetime.

Implementations

impl Heap

pub fn new() -> Self

Create a new Heap.

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 peak_allocated_bytes(&self) -> usize

Peak memory allocated to this heap, even if the value is now lower as a result of a subsequent garbage collection.

pub fn available_bytes(&self) -> usize

Number of bytes allocated by the heap but not yet filled.

pub fn alloc_str<'v>(&'v self, x: &str) -> StringValue<'v>

Allocate a string on the heap.

pub fn alloc_str_concat<'v>(&'v self, x: &str, y: &str) -> StringValue<'v>

Allocate a string on the heap, based on two concatenated strings.

pub fn alloc_str_concat3<'v>( &'v self, x: &str, y: &str, z: &str ) -> StringValue<'v>

Allocate a string on the heap, based on three concatenated strings.

pub fn alloc_simple<'v, T: StarlarkValue<'static> + Send + Sync>( &'v self, x: T ) -> Value<'v>

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)

Must be Send and Sync because it will be reused in frozen values.

pub fn alloc_complex<'v, T>(&'v self, x: T) -> Value<'v>

where T: ComplexValue<'v>, T::Frozen: StarlarkValue<'static>,

Allocate a ComplexValue on the Heap.

pub fn alloc_complex_no_freeze<'v, T>(&'v self, x: T) -> Value<'v>

where T: StarlarkValue<'v> + Trace<'v>,

Allocate a value which can be traced (garbage collected), but cannot be frozen.

pub fn alloc<'v, T: AllocValue<'v>>(&'v self, x: T) -> Value<'v>

Allocate a new value on a Heap.

pub fn alloc_typed<'v, T: AllocValue<'v> + StarlarkValue<'v>>( &'v self, x: T ) -> ValueTyped<'v, T>

Allocate a value and return ValueTyped of it. Can fail if the AllocValue trait generates a different type on the heap.

pub fn alloc_value_of<'v, T>(&'v self, x: T) -> ValueOf<'v, &'v T>

where T: AllocValue<'v>, &'v T: UnpackValue<'v>,

Allocate a value and return ValueOf of it.

pub fn allocated_summary(&self) -> HeapSummary

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

Trait Implementations

impl Debug for Heap

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

Formats the value using the given formatter.

impl Default for Heap

fn default() -> Heap

Returns the “default value” for a type.