Module yarnspinner::core

Core types and traits that are used by both the compiler and runtime.

Macros

• yarn_fn_type
  A macro for using YarnFn as a return type or parameter type without needing to know the implementation details of the YarnFn trait.
• yarn_library
  Create a Library from a list of named functions.

Structs

• Header
• Instruction
• InvalidOpCodeError
• Library
  A collection of functions that can be called from Yarn scripts.
• LineId
  The unique ID of a line in a Yarn script. In a Yarn script, line IDs look like this:
• Node
• Position
  Represents a position in a multi-line string.
• Program
• YarnValueWrapper
  Helper class for implementing something like YarnFn yourself. You probably don’t want to use this directly as a consumer unless you’re doing some wizardry.

Enums

• Type
  All types in the virtual machine, both built-in, i.e. usable in Yarn scripts, and internal.
• YarnValue
  Represents a Yarn value. The chosen variant corresponds to the last assignment of the value, with the type being inferred from the type checker.
• YarnValueCastError
  Represents a failure to convert one variant of YarnValue to a base type.

Traits

• IntoYarnValueFromNonYarnValue
  The return value of a [YarnFn]. See [YarnFn] for more information on the kinds of signatures that can be registered.
• UntypedYarnFn
  A YarnFn with the Marker type parameter erased. See its documentation for more information about what kind of functions are allowed.
• YarnFn
  A function that can be registered into and called from Yarn. It must have the following properties:
• YarnFnParam
  Trait implemented by types that can be used in YarnFn-like contexts. Implemented by the following types and references of them:

Type Aliases

• YarnFnParamItem
  Shorthand way of accessing the associated type YarnFnParam::Item for a given YarnFnParam.