Skip to main content

Value

Enum Value 

Source
pub enum Value {
    Nil,
    Bool(bool),
    Number(f64),
    String(String),
    Array(ArrayValue),
    Object(ObjectValue),
    Table(TableValue),
    Function(FunctionHandle),
    Native(NativeHandle),
    Host(HostHandle),
    Task(TaskHandle),
}
Expand description

Core runtime value.

Variants§

§

Nil

Absence of a value.

§

Bool(bool)

Boolean value.

§

Number(f64)

Kinetik number, represented as an IEEE-754 64-bit float.

§

String(String)

UTF-8 string value.

§

Array(ArrayValue)

Ordered array value.

§

Object(ObjectValue)

Plain JSON-native object value.

§

Table(TableValue)

Programmable table value.

§

Function(FunctionHandle)

Script function handle.

§

Native(NativeHandle)

Host/native value handle.

§

Host(HostHandle)

Opaque host object handle.

§

Task(TaskHandle)

Task/coroutine handle.

Implementations§

Source§

impl Value

Source

pub const fn nil() -> Value

Creates a nil value.

Source

pub const fn bool(value: bool) -> Value

Creates a boolean value.

Source

pub const fn number(value: f64) -> Value

Creates a number value.

Source

pub fn string(value: impl Into<String>) -> Value

Creates a string value.

Source

pub fn array(elements: impl Into<Vec<Value>>) -> Value

Creates an array value.

Source

pub fn object(fields: impl IntoIterator<Item = (String, Value)>) -> Value

Creates a plain object value.

Source

pub const fn table(id: TableId) -> Value

Creates a programmable table handle value.

Source

pub const fn function(id: FunctionId) -> Value

Creates a script function handle value.

Source

pub const fn native(id: NativeId) -> Value

Creates a native handle value.

Source

pub const fn host(id: HostId, generation: u64) -> Value

Creates an opaque host object handle value.

Source

pub const fn task(id: TaskId) -> Value

Creates a task handle value.

Source

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

Returns the stable runtime type name for this value.

Trait Implementations§

Source§

impl Clone for Value

Source§

fn clone(&self) -> Value

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Value

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Value

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromValue for Value

Source§

fn from_value(value: Value) -> Result<Self>

Converts a Kinetik value into this Rust type. Read more
Source§

impl IntoValue for Value

Source§

fn into_value(self) -> Value

Converts this value into a Kinetik value.
Source§

impl PartialEq for Value

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Value

Auto Trait Implementations§

§

impl Freeze for Value

§

impl RefUnwindSafe for Value

§

impl Send for Value

§

impl Sync for Value

§

impl Unpin for Value

§

impl UnsafeUnpin for Value

§

impl UnwindSafe for Value

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.