Enum GeneratorState

pub enum GeneratorState {
    Yielded(Value),
    Complete(Value),
}

The state of a generator.

use rune::{Value, Vm};
use rune::runtime::{Generator, GeneratorState};
use std::sync::Arc;

let mut sources = rune::sources! {
    entry => {
        pub fn main() {
            let n = yield 1;
            let out = yield n + 1;
            out
        }
    }
};

let unit = rune::prepare(&mut sources).build()?;

let mut vm = Vm::without_runtime(Arc::new(unit));
let mut execution = vm.execute(["main"], ())?;

// Initial resume doesn't take a value.
let first = match execution.resume().into_result()? {
    GeneratorState::Yielded(first) => rune::from_value::<i64>(first)?,
    GeneratorState::Complete(..) => panic!("generator completed"),
};

assert_eq!(first, 1);

// Additional resumes require a value.
let second = match execution.resume_with(rune::to_value(2i64)?).into_result()? {
    GeneratorState::Yielded(second) => rune::from_value::<i64>(second)?,
    GeneratorState::Complete(..) => panic!("generator completed"),
};

assert_eq!(second, 3);

let ret = match execution.resume_with(rune::to_value(42i64)?).into_result()? {
    GeneratorState::Complete(ret) => rune::from_value::<i64>(ret)?,
    GeneratorState::Yielded(..) => panic!("generator yielded"),
};

assert_eq!(ret, 42);

Variants

Yielded(Value)

The generator yielded.

Complete(Value)

The generator completed.

Implementations

impl GeneratorState

pub fn is_yielded(&self) -> bool

Test if the state is yielded.

pub fn is_complete(&self) -> bool

Test if the state is complete.

Trait Implementations

impl Any for GeneratorState

const ANY_TYPE_INFO: AnyTypeInfo = _

The compile-time type information know for the type.

impl Debug for GeneratorState

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

Formats the value using the given formatter.

impl InstallWith for GeneratorState

fn install_with(module: &mut Module) -> Result<(), ContextError>

Hook to install more things into the module.

impl IntoOutput for GeneratorState

fn into_output(self) -> Result<Value, RuntimeError>

Coerce the current value into an output.

impl MaybeTypeOf for GeneratorState

fn maybe_type_of() -> Result<DocType>

Type information for the given type.

impl Named for GeneratorState

const ITEM: &'static Item = _

The name item.

fn full_name(f: &mut Formatter<'_>) -> Result

The exact type name

fn display() -> impl Display

Return a display wrapper for the named type.

impl TryClone for GeneratorState

fn try_clone(&self) -> Result<Self>

Try to clone the current value, raising an allocation error if it’s unsuccessful.

fn try_clone_from(&mut self, source: &Self) -> Result<(), Error>

Performs copy-assignment from source.

impl TryFrom<GeneratorState> for Value

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TypeHash for GeneratorState

const HASH: Hash = _

The complete type hash of the type including type parameters which uniquely identifiers a given type.

impl TypeOf for GeneratorState

const PARAMETERS: Hash = _

Type parameters for the type.

const STATIC_TYPE_INFO: AnyTypeInfo = <Self as rune::Any>::ANY_TYPE_INFO

Access diagnostical type information for the current type.

fn type_info() -> TypeInfo

Get type info associated with the current type.

impl UnsafeToMut for GeneratorState

type Guard = RawValueGuard

The raw guard returned.

unsafe fn unsafe_to_mut<'a>( value: Value, ) -> Result<(&'a mut Self, Self::Guard), RuntimeError>

Safety

impl UnsafeToRef for GeneratorState

type Guard = RawValueGuard

The raw guard returned.

unsafe fn unsafe_to_ref<'a>( value: Value, ) -> Result<(&'a Self, Self::Guard), RuntimeError>

Safety

impl UnsafeToValue for &GeneratorState

type Guard = ValueRefGuard

The type used to guard the unsafe value conversion.

unsafe fn unsafe_to_value(self) -> Result<(Value, Self::Guard), RuntimeError>

Convert into a value.

impl UnsafeToValue for &mut GeneratorState

type Guard = ValueMutGuard

The type used to guard the unsafe value conversion.

unsafe fn unsafe_to_value(self) -> Result<(Value, Self::Guard), RuntimeError>

Convert into a value.