Struct Value 

pub struct Value { /* private fields */ }

Implementations

impl Value

pub fn descriptor(&self) -> &'static TypeDescriptor

The word’s canonical descriptor singleton: the vtable backing its lifecycle and operations.

pub fn type_name(&self) -> &'static str

The word’s registered type name (the descriptor’s name).

pub fn inline_bits(&self) -> u64

Raw payload bits, copied out. Meaningful for inline words (the value’s bytes); for heap words these are the box pointer’s bits.

pub fn heap_ptr(&self) -> *mut ()

Heap box (exclusive) or buffer (shared) pointer, copied out. Only meaningful for heap words; never dereferenced here. Reading (not dereferencing) is safe.

pub fn mint_inline<T>(descriptor: &'static TypeDescriptor, value: T) -> Self

where T: Copy + PartialEq + Display + Debug + Send + Sync + 'static,

Mint an inline word: memcpy the value’s bytes into the payload. Zero allocation. The descriptor must be the payload type’s own OxDockType::descriptor(); mismatching them misdirects the vtable and is unsound.

pub fn mint_heap<T>(descriptor: &'static TypeDescriptor, value: T) -> Self

where T: Clone + PartialEq + Display + Debug + Send + Sync + 'static,

Mint an exclusive heap word: move the value into an owned Box<T> behind a thin pointer. One box allocation. The descriptor must be the payload type’s own OxDockType::descriptor(); mismatching them misdirects the vtable and is unsound.

pub fn mint_heap_shared<T>( descriptor: &'static TypeDescriptor, value: T, ) -> Self

where T: Clone + PartialEq + Display + Debug + Send + Sync + 'static,

Mint a shared heap word: move the value into a reference-counted Arc<T> behind a thin pointer. One allocation; later clones bump the strong count instead of copying. The descriptor must be the payload type’s own OxDockType::descriptor() built for the shared path (#[oxdock_type(shared)]); mismatching them misdirects the vtable and is unsound.

pub fn read_inline<T>(&self, expected: &'static TypeDescriptor) -> Option<T>

where T: Copy + PartialEq + Display + Debug + Send + Sync + 'static,

Read an inline word back out. Returns None when the word carries a different descriptor; the load itself is infallible for a word minted for T.

pub fn read_heap<T>(&self, expected: &'static TypeDescriptor) -> Option<&T>

where T: Clone + PartialEq + Display + Debug + Send + Sync + 'static,

Borrow a heap word’s concrete value. Returns None when the word carries a different descriptor.

pub fn read_heap_mut<T>( &mut self, expected: &'static TypeDescriptor, ) -> Option<&mut T>

where T: Clone + PartialEq + Display + Debug + Send + Sync + 'static,

Borrow a heap word’s concrete value mutably, detaching shared buffers first (copy-on-write). Returns None when the word carries a different descriptor. This is the only sound way to obtain &mut access to a heap payload: exclusive heaps hand out their box directly, shared heaps clone-then-hand-out when the strong count exceeds 1 and mutate in place otherwise. Panics when called with an inline descriptor, which has no heap buffer.

pub fn int(n: i64) -> Self

Construct an integer word (inline, zero allocation).

pub fn float(f: f64) -> Self

Construct a float word (inline, zero allocation).

pub fn bool(b: bool) -> Self

Construct a boolean word (inline, zero allocation).

pub fn handle(id: u64) -> Self

Construct a task-handle word (inline, zero allocation).

pub fn string(s: String) -> Self

Construct a string word.

pub fn list(items: Vec<Value>) -> Self

Construct a list word (shared heap: clones share the buffer).

pub fn map(entries: BTreeMap<String, Value>) -> Self

Construct a map word (shared heap: clones share the buffer).

pub fn path(p: PathBuf) -> Self

Construct a path word.

pub fn duration(d: Duration) -> Self

Construct a duration word.

pub fn pipe(name: String) -> Self

Construct a pipe-name word.

pub fn as_i64(&self) -> Option<i64>

Read an integer payload. Returns None for non-INT words.

pub fn as_f64(&self) -> Option<f64>

Read a float payload. Returns None for non-FLOAT words.

pub fn as_bool(&self) -> Option<bool>

Read a boolean payload. Returns None for non-BOOL words.

pub fn as_handle(&self) -> Option<u64>

Read a task-handle payload. Returns None for non-HANDLE words.

pub fn as_str(&self) -> Option<&str>

Borrow a string payload. Returns None for non-STRING words.

pub fn as_list(&self) -> Option<&Vec<Value>>

Borrow a list payload. Returns None for non-LIST words.

pub fn as_list_mut(&mut self) -> Option<&mut Vec<Value>>

Borrow a list payload mutably, detaching the shared buffer first when clones exist. Returns None for non-LIST words. This is the choke point every future in-place container mutation must go through.

pub fn as_map(&self) -> Option<&BTreeMap<String, Value>>

Borrow a map payload. Returns None for non-MAP words.

pub fn as_map_mut(&mut self) -> Option<&mut BTreeMap<String, Value>>

Borrow a map payload mutably, detaching the shared buffer first when clones exist. Returns None for non-MAP words. This is the choke point every future in-place container mutation must go through.

pub fn as_pipe_name(&self) -> Option<&str>

Borrow a pipe-name payload. Returns None for non-PIPE words.

pub fn as_duration(&self) -> Option<Duration>

Read a duration payload. Returns None for non-DURATION words.

pub fn as_path(&self) -> Option<&Path>

Borrow a path payload. Returns None for non-PATH words.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Display for Value

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

Formats the value using the given formatter.

impl Drop for Value

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl PartialEq for Value

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

Equality operator ==.

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

Inequality operator !=.

impl Send for Value

A DSL value: a TypeDescriptor vtable pointer plus a ValuePayload. Fixed size (128 bits on 64-bit targets). Lifecycle and operations call the vtable directly, with no table lookup and no lock; see the module docs for the ownership discipline.

impl Sync for Value