Struct ConstValueBuf

Source

pub struct ConstValueBuf { /* private fields */ }

Expand description

A constant value which owns what it is made of.

This is the owned half of the pair, the way ItemBuf is to Item. Everything it is made of is in one allocation, so cloning one is one copy and dropping one is one deallocation, whatever shape the constant is.

Implementations§

Source §

impl ConstValueBuf

Source

pub fn string(value: impl AsRef<str>) -> Result<ConstValueBuf, RuntimeError>

Construct a constant value that is a string.

Source

pub fn bytes(value: impl AsRef<[u8]>) -> Result<ConstValueBuf, RuntimeError>

Construct a constant value that is bytes.

Source

pub fn tuple(fields: I) -> Result<ConstValueBuf, RuntimeError>
where I: IntoIterator, I::Item: AsRef<ConstValue>, I::IntoIter: ExactSizeIterator,

Construct a new tuple constant value.

Source

pub fn for_struct<const N: usize>( hash: Hash, fields: [ConstValueBuf; N], ) -> Result<ConstValueBuf, RuntimeError>

Construct a constant value for a struct.

Methods from Deref<Target = ConstValue>§

Source

pub fn fields(&self) -> ConstFields<'_>

The subtrees which follow the root, whatever it is.

This is what the code written by the ToConstValue derive reads a constant’s fields back out of.

Source

pub fn as_integer<T>(&self) -> Result<T, RuntimeError>
where T: TryFrom<i64> + TryFrom<u64>,

Try to coerce the current value as the specified integer T.

§Examples

let value = rune::to_const_value(u32::MAX)?;

assert_eq!(value.as_integer::<u64>()?, u32::MAX as u64);
assert!(value.as_integer::<i32>().is_err());

Source

pub fn as_ordering(&self) -> Result<Ordering, RuntimeError>

Coerce into Ordering.

This gets a copy of the value.

Source

pub fn as_ordering_mut(&mut self) -> Result<&mut Ordering, RuntimeError>

Coerce into Ordering.

This gets the value by mutable reference.

Source

pub fn as_bool(&self) -> Result<bool, RuntimeError>

Coerce into bool.

This gets a copy of the value.

Source

pub fn as_bool_mut(&mut self) -> Result<&mut bool, RuntimeError>

Coerce into bool.

This gets the value by mutable reference.

Source

pub fn as_char(&self) -> Result<char, RuntimeError>

Coerce into char.

This gets a copy of the value.

Source

pub fn as_char_mut(&mut self) -> Result<&mut char, RuntimeError>

Coerce into char.

This gets the value by mutable reference.

Source

pub fn as_unsigned(&self) -> Result<u64, RuntimeError>

Coerce into u64 unsigned integer.

This gets a copy of the value.

Source

pub fn as_unsigned_mut(&mut self) -> Result<&mut u64, RuntimeError>

Coerce into u64 unsigned integer.

This gets the value by mutable reference.

Source

pub fn as_signed(&self) -> Result<i64, RuntimeError>

Coerce into i64 signed integer.

This gets a copy of the value.

Source

pub fn as_signed_mut(&mut self) -> Result<&mut i64, RuntimeError>

Coerce into i64 signed integer.

This gets the value by mutable reference.

Source

pub fn as_float(&self) -> Result<f64, RuntimeError>

Coerce into f64 float.

This gets a copy of the value.

Source

pub fn as_float_mut(&mut self) -> Result<&mut f64, RuntimeError>

Coerce into f64 float.

This gets the value by mutable reference.

Source

pub fn as_type(&self) -> Result<Type, RuntimeError>

Coerce into Type.

This gets a copy of the value.

Source

pub fn as_type_mut(&mut self) -> Result<&mut Type, RuntimeError>

Coerce into Type.

This gets the value by mutable reference.

Source

pub fn as_string(&self) -> Result<&str, ExpectedType>

Coerce into the string this is, if it is one.

Source

pub fn as_tuple(&self) -> Result<ConstFields<'_>, ExpectedType>

Coerce into the fields of the tuple this is, if it is one.

Trait Implementations§

Source §

impl AsRef<ConstValue> for ConstValueBuf

Source §

fn as_ref(&self) -> &ConstValue

Converts this type into a shared reference of the (usually inferred) input type.

Source §

impl Borrow<ConstValue> for ConstValueBuf

Source §

fn borrow(&self) -> &ConstValue

Immutably borrows from an owned value. Read more

Source §

impl Debug for ConstValueBuf

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<'de, M, A> Decode<'de, M, A> for ConstValueBuf
where A: Allocator, ConstNodeKind: Decode<'de, M, A>,

Available on crate feature musli only.

Source §

const IS_BITWISE_DECODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type. Read more

Source §

fn decode<D>(decoder: D) -> Result<Self, D::Error>
where D: Decoder<'de, Mode = M, Allocator = A>,

Decode the current value.

Source §

impl Deref for ConstValueBuf

Source §

type Target = ConstValue

The resulting type after dereferencing.

Source §

fn deref(&self) -> &Self::Target

Dereferences the value.

Source §

impl DerefMut for ConstValueBuf

Source §

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

Source §

impl<'de> Deserialize<'de> for ConstValueBuf

Available on crate feature serde only.

Reading a constant back checks that what was written down is a tree, and that it is one within the limits, before anything walks it.

Source §

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Source §

impl<M> Encode<M> for ConstValueBuf
where ConstNodeKind: Encode<M>,

Available on crate feature musli only.

Source §

const IS_BITWISE_ENCODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type. Read more

Source §

type Encode = ConstValueBuf

The underlying type being encoded. Read more

Source §

fn encode<E>(&self, encoder: E) -> Result<(), E::Error>
where E: Encoder<Mode = M>,

Encode the given output.

Source §

fn as_encode(&self) -> &Self::Encode

Coerce into the underlying value being encoded.

Source §

fn size_hint(&self) -> Option<usize>

The number of fields in the type.

Source §