Struct StrykeValue 

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

NaN-boxed value: one u64 (immediates, raw float bits, or tagged heap pointer).

Implementations

impl StrykeValue

pub fn dup_stack(&self) -> Self

Stack duplicate (Op::Dup): share the outer heap Arc for arrays/hashes (COW on write), matching Perl temporaries; other heap payloads keep Clone semantics.

pub fn shallow_clone(&self) -> Self

Refcount-only clone: Arc::clone the heap pointer (no deep copy of the payload).

Use this when producing a second handle to the same value that the caller will read-only or consume via Self::into_string / Arc::try_unwrap-style uniqueness checks. Cheap O(1) regardless of the payload size.

The default Clone impl deep-copies String/Array/Hash payloads to preserve “clone = independent writable value” semantics for legacy callers; in hot RMW paths (.=, slot stash-and-return) that deep copy is O(N) and must be avoided — use this instead.

impl StrykeValue

pub const UNDEF: StrykeValue

pub fn is_integer_like(&self) -> bool

typed : Int — inline i32 or heap i64.

pub fn is_float_like(&self) -> bool

Raw f64 bits or heap boxed float (NaN/Inf).

pub fn is_string_like(&self) -> bool

Heap UTF-8 string only.

pub fn integer(n: i64) -> Self

pub fn bigint(n: BigInt) -> Self

Wrap a BigInt. If it fits in i64, demotes to a regular integer so downstream consumers don’t have to special-case BigInt for small values.

pub fn as_bigint(&self) -> Option<Arc<BigInt>>

Returns the inner BigInt as Arc (zero-copy) when this value is a boxed BigInt; None otherwise. Use Self::to_bigint to coerce from i64/f64/strings.

pub fn to_bigint(&self) -> BigInt

Coerce any numeric value into a BigInt. Floats truncate. Used by arithmetic promotion paths under --compat when one side overflowed.

pub fn float(f: f64) -> Self

pub fn string(s: String) -> Self

pub fn bytes(b: Arc<Vec<u8>>) -> Self

pub fn array(v: Vec<StrykeValue>) -> Self

pub fn iterator(it: Arc<dyn StrykeIterator>) -> Self

Wrap a lazy iterator as a StrykeValue.

pub fn is_iterator(&self) -> bool

True when this value is a lazy iterator.

pub fn into_iterator(&self) -> Arc<dyn StrykeIterator>

Extract the iterator Arc (panics if not an iterator).

pub fn hash(h: IndexMap<String, StrykeValue>) -> Self

pub fn array_ref(a: Arc<RwLock<Vec<StrykeValue>>>) -> Self

pub fn hash_ref(h: Arc<RwLock<IndexMap<String, StrykeValue>>>) -> Self

pub fn scalar_ref(r: Arc<RwLock<StrykeValue>>) -> Self

pub fn capture_cell(r: Arc<RwLock<StrykeValue>>) -> Self

pub fn scalar_binding_ref(name: String) -> Self

pub fn array_binding_ref(name: String) -> Self

pub fn hash_binding_ref(name: String) -> Self

pub fn code_ref(c: Arc<StrykeSub>) -> Self

pub fn as_code_ref(&self) -> Option<Arc<StrykeSub>>

pub fn as_regex(&self) -> Option<Arc<PerlCompiledRegex>>

pub fn as_blessed_ref(&self) -> Option<Arc<BlessedRef>>

pub fn hash_get(&self, key: &str) -> Option<StrykeValue>

Hash lookup when this value is a plain HeapObject::Hash (not a ref).

pub fn is_undef(&self) -> bool

pub fn is_simple_scalar(&self) -> bool

True for simple scalar values (integer, float, string, undef, bytes) that should be wrapped in ScalarRef for closure variable sharing. Complex heap objects like refs, blessed objects, code refs, etc. should NOT be wrapped because they already share state via Arc and wrapping breaks type detection.

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

Immediate int32 or heap Integer (not float / string).

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

pub fn as_array_vec(&self) -> Option<Vec<StrykeValue>>

pub fn map_flatten_outputs(&self, peel_array_ref: bool) -> Vec<StrykeValue>

Expand a map / flat_map / pflat_map block result into list elements. Plain arrays expand; when peel_array_ref, a single ARRAY ref is dereferenced one level (stryke flat_map / pflat_map; stock map uses peel_array_ref == false).

pub fn as_hash_map(&self) -> Option<IndexMap<String, StrykeValue>>

pub fn as_bytes_arc(&self) -> Option<Arc<Vec<u8>>>

pub fn as_async_task(&self) -> Option<Arc<StrykeAsyncTask>>

pub fn as_generator(&self) -> Option<Arc<PerlGenerator>>

pub fn as_atomic_arc(&self) -> Option<Arc<Mutex<StrykeValue>>>

pub fn as_io_handle_name(&self) -> Option<String>

pub fn as_sqlite_conn(&self) -> Option<Arc<Mutex<Connection>>>

pub fn as_struct_inst(&self) -> Option<Arc<StructInstance>>

pub fn as_enum_inst(&self) -> Option<Arc<EnumInstance>>

pub fn as_class_inst(&self) -> Option<Arc<ClassInstance>>

pub fn as_dataframe(&self) -> Option<Arc<Mutex<PerlDataFrame>>>

pub fn as_deque(&self) -> Option<Arc<Mutex<VecDeque<StrykeValue>>>>

pub fn as_heap_pq(&self) -> Option<Arc<Mutex<PerlHeap>>>

pub fn as_pipeline(&self) -> Option<Arc<Mutex<PipelineInner>>>

pub fn as_capture(&self) -> Option<Arc<CaptureResult>>

pub fn as_ppool(&self) -> Option<PerlPpool>

pub fn as_remote_cluster(&self) -> Option<Arc<RemoteCluster>>

pub fn as_barrier(&self) -> Option<PerlBarrier>

pub fn as_channel_tx(&self) -> Option<Arc<Sender<StrykeValue>>>

pub fn as_channel_rx(&self) -> Option<Arc<Receiver<StrykeValue>>>

pub fn as_scalar_ref(&self) -> Option<Arc<RwLock<StrykeValue>>>

pub fn as_capture_cell(&self) -> Option<Arc<RwLock<StrykeValue>>>

Returns the inner Arc if this is a [HeapObject::CaptureCell].

pub fn as_scalar_binding_name(&self) -> Option<String>

Name of the scalar slot for [HeapObject::ScalarBindingRef], if any.

pub fn as_array_binding_name(&self) -> Option<String>

Stash-qualified array name for [HeapObject::ArrayBindingRef], if any.

pub fn as_hash_binding_name(&self) -> Option<String>

Hash name for [HeapObject::HashBindingRef], if any.

pub fn as_array_ref(&self) -> Option<Arc<RwLock<Vec<StrykeValue>>>>

pub fn as_hash_ref(&self) -> Option<Arc<RwLock<IndexMap<String, StrykeValue>>>>

pub fn is_mysync_deque_or_heap(&self) -> bool

mysync: deque / priority heap — already Arc<Mutex<…>>.

pub fn regex( rx: Arc<PerlCompiledRegex>, pattern_src: String, flags: String, ) -> Self

pub fn regex_src_and_flags(&self) -> Option<(String, String)>

Pattern and flag string stored with a compiled regex (for =~ / [Op::RegexMatchDyn]).

pub fn blessed(b: Arc<BlessedRef>) -> Self

pub fn io_handle(name: String) -> Self

pub fn atomic(a: Arc<Mutex<StrykeValue>>) -> Self

pub fn set(s: Arc<PerlSet>) -> Self

pub fn channel_tx(tx: Arc<Sender<StrykeValue>>) -> Self

pub fn channel_rx(rx: Arc<Receiver<StrykeValue>>) -> Self

pub fn async_task(t: Arc<StrykeAsyncTask>) -> Self

pub fn generator(g: Arc<PerlGenerator>) -> Self

pub fn deque(d: Arc<Mutex<VecDeque<StrykeValue>>>) -> Self

pub fn heap(h: Arc<Mutex<PerlHeap>>) -> Self

pub fn mutex() -> Self

Construct a fresh, unlocked [HeapObject::Mutex].

pub fn semaphore(n: i64) -> Self

Construct a [HeapObject::Semaphore] with n permits (n is clamped to >= 0 by the caller — see builtins_sync::semaphore_new).

pub fn as_mutex(&self) -> Option<Arc<MutexHandle>>

Borrow-the-inner-handle accessor for [HeapObject::Mutex] (returns the Arc so the handle outlives the temporary StrykeValue).

pub fn as_semaphore(&self) -> Option<Arc<SemaphoreHandle>>

Borrow-the-inner-handle accessor for [HeapObject::Semaphore].

pub fn bloom_filter(b: Arc<Mutex<BloomFilter>>) -> Self

pub fn as_bloom_filter(&self) -> Option<Arc<Mutex<BloomFilter>>>

pub fn hll_sketch(h: Arc<Mutex<HllSketch>>) -> Self

pub fn as_hll_sketch(&self) -> Option<Arc<Mutex<HllSketch>>>

pub fn cms_sketch(c: Arc<Mutex<CmsSketch>>) -> Self

pub fn as_cms_sketch(&self) -> Option<Arc<Mutex<CmsSketch>>>

pub fn topk_sketch(t: Arc<Mutex<TopKSketch>>) -> Self

pub fn as_topk_sketch(&self) -> Option<Arc<Mutex<TopKSketch>>>

pub fn tdigest_sketch(t: Arc<Mutex<TDigestSketch>>) -> Self

pub fn as_tdigest_sketch(&self) -> Option<Arc<Mutex<TDigestSketch>>>

pub fn roaring_bitmap(r: Arc<Mutex<RoaringBitmapSketch>>) -> Self

pub fn as_roaring_bitmap(&self) -> Option<Arc<Mutex<RoaringBitmapSketch>>>

pub fn rate_limiter(r: Arc<Mutex<RateLimiterSketch>>) -> Self

pub fn as_rate_limiter(&self) -> Option<Arc<Mutex<RateLimiterSketch>>>

pub fn hash_ring(r: Arc<Mutex<HashRingSketch>>) -> Self

pub fn as_hash_ring(&self) -> Option<Arc<Mutex<HashRingSketch>>>

pub fn simhash(s: Arc<Mutex<SimHashSketch>>) -> Self

pub fn as_simhash(&self) -> Option<Arc<Mutex<SimHashSketch>>>

pub fn minhash(m: Arc<Mutex<MinHashSketch>>) -> Self

pub fn as_minhash(&self) -> Option<Arc<Mutex<MinHashSketch>>>

pub fn interval_tree(t: Arc<Mutex<IntervalTreeSketch>>) -> Self

pub fn as_interval_tree(&self) -> Option<Arc<Mutex<IntervalTreeSketch>>>

pub fn bk_tree(t: Arc<Mutex<BkTreeSketch>>) -> Self

pub fn as_bk_tree(&self) -> Option<Arc<Mutex<BkTreeSketch>>>

pub fn rope(r: Arc<Mutex<RopeSketch>>) -> Self

pub fn as_rope(&self) -> Option<Arc<Mutex<RopeSketch>>>

pub fn kv_store(k: Arc<Mutex<KvStore>>) -> Self

pub fn as_kv_store(&self) -> Option<Arc<Mutex<KvStore>>>

pub fn pipeline(p: Arc<Mutex<PipelineInner>>) -> Self

pub fn capture(c: Arc<CaptureResult>) -> Self

pub fn ppool(p: PerlPpool) -> Self

pub fn remote_cluster(c: Arc<RemoteCluster>) -> Self

pub fn barrier(b: PerlBarrier) -> Self

pub fn sqlite_conn(c: Arc<Mutex<Connection>>) -> Self

pub fn struct_inst(s: Arc<StructInstance>) -> Self

pub fn enum_inst(e: Arc<EnumInstance>) -> Self

pub fn class_inst(c: Arc<ClassInstance>) -> Self

pub fn dataframe(df: Arc<Mutex<PerlDataFrame>>) -> Self

pub fn errno_dual(code: i32, msg: String) -> Self

OS errno dualvar ($!) or eval-error dualvar ($@): to_int/to_number use code; string context uses msg.

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

Heap string payload, if any (allocates).

pub fn append_to(&self, buf: &mut String)

pub fn unwrap_atomic(&self) -> StrykeValue

pub fn is_atomic(&self) -> bool

pub fn is_true(&self) -> bool

pub fn into_string(self) -> String

pub fn as_str_or_empty(&self) -> String

pub fn to_number(&self) -> f64

pub fn to_int(&self) -> i64

pub fn type_name(&self) -> String

pub fn ref_type(&self) -> StrykeValue

pub fn num_cmp(&self, other: &StrykeValue) -> Ordering

pub fn str_eq(&self, other: &StrykeValue) -> bool

String equality for eq / cmp without allocating when both sides are heap strings.

pub fn str_cmp(&self, other: &StrykeValue) -> Ordering

pub fn struct_field_eq(&self, other: &StrykeValue) -> bool

Deep equality for struct fields (recursive).

pub fn deep_clone(&self) -> StrykeValue

Deep clone a value (used for struct clone).

pub fn to_list(&self) -> Vec<StrykeValue>

pub fn scalar_context(&self) -> StrykeValue

Trait Implementations

impl Clone for StrykeValue

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 StrykeValue

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

Formats the value using the given formatter.

impl Default for StrykeValue

fn default() -> Self

Returns the “default value” for a type.

impl Display for StrykeValue

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

Formats the value using the given formatter.

impl Drop for StrykeValue

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.