Enum koto_runtime::prelude::KValue

pub enum KValue {
    Null,
    Bool(bool),
    Number(KNumber),
    Range(KRange),
    List(KList),
    Tuple(KTuple),
    Map(KMap),
    Str(KString),
    Function(KFunction),
    CaptureFunction(Ptr<KCaptureFunction>),
    NativeFunction(KNativeFunction),
    Iterator(KIterator),
    Object(KObject),
    TemporaryTuple(RegisterSlice),
}

The core Value type for Koto

Variants

Null

The default type representing the absence of a value

Bool(bool)

A boolean, can be either true or false

Number(KNumber)

A number, represented as either a signed 64 bit integer or float

Range(KRange)

A range with start/end boundaries

List(KList)

The list type used in Koto

Tuple(KTuple)

The tuple type used in Koto

Map(KMap)

The hash map type used in Koto

Str(KString)

The string type used in Koto

Function(KFunction)

A Koto function

CaptureFunction(Ptr<KCaptureFunction>)

A Koto function with captures

NativeFunction(KNativeFunction)

A function that’s implemented outside of the Koto runtime

Iterator(KIterator)

The iterator type used in Koto

Object(KObject)

An object with behaviour defined via the KotoObject trait

TemporaryTuple(RegisterSlice)

A tuple of values that are packed into a contiguous series of registers

Used as an optimization when multiple values are passed around without being assigned to a single Tuple value.

Note: this is intended for internal use only.

Implementations

impl KValue

pub fn deep_copy(&self) -> Result<KValue>

Returns a recursive ‘deep copy’ of a Value

This is used by koto.deep_copy.

pub fn is_callable(&self) -> bool

Returns true if the value has function-like callable behaviour

pub fn is_generator(&self) -> bool

Returns true if the value is a generator function

pub fn is_hashable(&self) -> bool

Returns true if the value is hashable

Only hashable values are acceptable as map keys.

pub fn is_iterable(&self) -> bool

Returns true if a KIterator can be made from the value

pub fn type_as_string(&self) -> KString

Returns the value’s type as a KString

pub fn display(&self, ctx: &mut DisplayContext<'_>) -> Result<()>

Renders the value into the provided display context

Trait Implementations

impl Clone for KValue

fn clone(&self) -> KValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KValue

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

Formats the value using the given formatter.

impl Default for KValue

fn default() -> KValue

Returns the “default value” for a type.

impl From<&f32> for KValue

fn from(value: &f32) -> Self

Converts to this type from the input type.

impl From<&f64> for KValue

fn from(value: &f64) -> Self

Converts to this type from the input type.

impl From<&i16> for KValue

fn from(value: &i16) -> Self

Converts to this type from the input type.

impl From<&i32> for KValue

fn from(value: &i32) -> Self

Converts to this type from the input type.

impl From<&i64> for KValue

fn from(value: &i64) -> Self

Converts to this type from the input type.

impl From<&i8> for KValue

fn from(value: &i8) -> Self

Converts to this type from the input type.

impl From<&isize> for KValue

fn from(value: &isize) -> Self

Converts to this type from the input type.

impl From<&str> for KValue

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<&u16> for KValue

fn from(value: &u16) -> Self

Converts to this type from the input type.

impl From<&u32> for KValue

fn from(value: &u32) -> Self

Converts to this type from the input type.

impl From<&u64> for KValue

fn from(value: &u64) -> Self

Converts to this type from the input type.

impl From<&u8> for KValue

fn from(value: &u8) -> Self

Converts to this type from the input type.

impl From<&usize> for KValue

fn from(value: &usize) -> Self

Converts to this type from the input type.

impl From<()> for KValue

fn from(_: ()) -> Self

Converts to this type from the input type.

impl From<Chunk> for KValue

fn from(chunk: Chunk) -> Self

Converts to this type from the input type.

impl From<File> for KValue

fn from(file: File) -> Self

Converts to this type from the input type.

impl From<IteratorOutput> for KValue

fn from(output: IteratorOutput) -> Self

Converts to this type from the input type.

impl From<KIterator> for KValue

fn from(value: KIterator) -> Self

Converts to this type from the input type.

impl From<KList> for KValue

fn from(value: KList) -> Self

Converts to this type from the input type.

impl From<KMap> for KValue

fn from(value: KMap) -> Self

Converts to this type from the input type.

impl From<KNativeFunction> for KValue

fn from(value: KNativeFunction) -> Self

Converts to this type from the input type.

impl From<KNumber> for KValue

fn from(value: KNumber) -> Self

Converts to this type from the input type.

impl From<KObject> for KValue

fn from(value: KObject) -> Self

Converts to this type from the input type.

impl From<KRange> for KValue

fn from(value: KRange) -> Self

Converts to this type from the input type.

impl From<KString> for KValue

fn from(value: KString) -> Self

Converts to this type from the input type.

impl From<KTuple> for KValue

fn from(value: KTuple) -> Self

Converts to this type from the input type.

impl From<KValue> for IteratorOutput

fn from(value: KValue) -> Self

Converts to this type from the input type.

impl From<String> for KValue

fn from(value: String) -> Self

Converts to this type from the input type.

impl<T> From<T> for KValue

where T: KotoFunction,

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<bool> for KValue

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f32> for KValue

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for KValue

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i16> for KValue

fn from(value: i16) -> Self

Converts to this type from the input type.

impl From<i32> for KValue

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for KValue

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<i8> for KValue

fn from(value: i8) -> Self

Converts to this type from the input type.

impl From<isize> for KValue

fn from(value: isize) -> Self

Converts to this type from the input type.

impl From<u16> for KValue

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for KValue

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for KValue

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for KValue

fn from(value: u8) -> Self

Converts to this type from the input type.

impl From<usize> for KValue

fn from(value: usize) -> Self

Converts to this type from the input type.

impl TryFrom<KIteratorOutput> for KValue

type Error = Error

The type returned in the event of a conversion error.

fn try_from(iterator_output: KIteratorOutput) -> StdResult<Self, Self::Error>

Performs the conversion.

impl TryFrom<KValue> for ValueKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: KValue) -> Result<Self, Self::Error>

Performs the conversion.