Module koto_runtime::prelude

A collection of useful items to make it easier to work with koto_runtime

Macros

• make_ptr
  Makes a Ptr, with support for casting to trait objects
• make_ptr_mut
  Makes a PtrMut, with support for casting to trait objects
• runtime_error
  Creates a crate::Error from a message (with format-like behaviour), wrapped in Err

Structs

• CallContext
  The context provided when a call to a KNativeFunction is made
• DisplayContext
  A helper for converting Koto values to strings
• KCell
  A mutable value with borrowing checked at runtime
• KIterator
  The iterator value type used in Koto
• KList
  The Koto runtime’s List type
• KMap
  The core hashmap value type used in Koto, containing a ValueMap and a MetaMap
• KNativeFunction
  An function that’s defined outside of the Koto runtime
• KObject
  A wrapper for KotoObjects used in the Koto runtime
• KRange
  The integer range type used by the Koto runtime
• KString
  The String type used by the Koto runtime
• KTuple
  The Tuple type used by the Koto runtime
• KotoVm
  The Koto runtime’s virtual machine
• KotoVmSettings
  The configurable settings that should be used by the Koto runtime
• MetaMap
  The meta map used by KMap
• MethodContext
  Context provided to a function that implements an object method
• ValueKey
  The key type used by ValueMap
• ValueMap
  The (ValueKey -> Value) ‘data’ hashmap used by the Koto runtime

Enums

• BinaryOp
  The binary operations that can be implemented in a MetaMap
• CallArgs
  Function call arguments
• IsIterable
  An enum that indicates to the runtime if a KotoObject is iterable
• KIteratorOutput
  The output type for iterators in Koto
• KNumber
  The Number type used by the Koto runtime
• KValue
  The core Value type for Koto
• MetaKey
  The key type used by MetaMaps
• UnaryOp
  The unary operations that can be implemented in a MetaMap

Traits

• KotoCopy
  A trait for defining how objects should behave when copied in the Koto runtime
• KotoEntries
  A trait that allows objects to support ‘.’ lookups
• KotoFile
  A trait used for file-like-things in Koto
• KotoFunction
  A trait for native functions used by the Koto runtime
• KotoIterator
  The trait used to implement iterators in Koto
• KotoObject
  A trait for implementing objects that can be added to the Koto runtime
• KotoRead
  A trait that defines the read operations of a KotoFile
• KotoSend
  Types that can be transferred across thread boundaries.
• KotoSync
  Types for which it is safe to share references between threads.
• KotoType
  A trait for specifying a Koto object’s type
• KotoWrite
  A trait that defines the write operations of a KotoFile

Functions

• type_error
  Creates an error that describes a type mismatch
• type_error_with_slice
  Creates an error that describes a type mismatch with a slice of KValues

Type Aliases

• KotoHasher
  The hasher used throughout the Koto runtime
• ValueVec
  The underlying Vec type used by KList