Struct Generator

pub struct Generator<T = Vm>
where
    T: AsRef<Vm> + AsMut<Vm>,
{ /* private fields */ }

A generator produced by a generator function.

Generator are functions or closures which contain the yield expressions.

Examples

use std::ops::generator::Generator;

let f = |n| {
    yield n;
    yield n + 1;
};

let g = f(10);

assert!(g is Generator);

Implementations

impl<T> Generator<T>

where T: AsRef<Vm> + AsMut<Vm>,

pub fn next(&mut self) -> VmResult<Option<Value>>

Get the next value produced by this stream.

pub fn resume(&mut self, value: Value) -> VmResult<GeneratorState>

Resume the generator with a value and get the next generator state.

impl Generator<&mut Vm>

pub fn into_owned(self) -> Generator<Vm>

Convert the current generator into one which owns its virtual machine.

impl Generator

pub fn rune_iter(self) -> Iter

Convert into iterator

Trait Implementations

impl Any for Generator<Vm>

const ANY_TYPE_INFO: AnyTypeInfo = _

The compile-time type information know for the type.

impl<T> Debug for Generator<T>

where T: AsRef<Vm> + AsMut<Vm>,

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

Formats the value using the given formatter.

impl InstallWith for Generator<Vm>

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

Hook to install more things into the module.

impl IntoIterator for Generator

type Item = Result<Value, VmError>

The type of the elements being iterated over.

type IntoIter = Iter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoOutput for Generator

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

Coerce the current value into an output.

impl MaybeTypeOf for Generator<Vm>

fn maybe_type_of() -> Result<DocType>

Type information for the given type.

impl Named for Generator<Vm>

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<T> TryClone for Generator<T>

where T: TryClone + AsRef<Vm> + AsMut<Vm>,

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

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<Generator> for Value

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TypeHash for Generator<Vm>

const HASH: Hash = _

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

impl TypeOf for Generator<Vm>

const PARAMETERS: Hash = _

Type parameters for the type.

const STATIC_TYPE_INFO: AnyTypeInfo = <Self as crate::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 Generator<Vm>

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 Generator<Vm>

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 &Generator<Vm>

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 Generator<Vm>

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.