Struct Output

#[non_exhaustive]
pub struct Output { /* private fields */ }

What to do with the output of an instruction.

Implementations

impl Output

pub fn store<M, O>(self, stack: &mut M, o: O) -> Result<(), RuntimeError>

where M: ?Sized + Memory, O: IntoOutput,

Write output using the provided IntoOutput implementation onto the stack.

The IntoOutput trait primarily allows for deferring a computation since it’s implemented by FnOnce. However, you must take care that any side effects calling a function may have are executed outside of the call to store. Like if the function would error.

Examples

use rune::runtime::{Output, Memory, ToValue, VmResult, InstAddress};
use rune::vm_try;

fn sum(stack: &mut dyn Memory, addr: InstAddress, args: usize, out: Output) -> VmResult<()> {
    let mut number = 0;

    for value in vm_try!(stack.slice_at(addr, args)) {
        number += vm_try!(value.as_integer::<i64>());
    }

    out.store(stack, number);
    VmResult::Ok(())
}

Trait Implementations

impl Clone for Output

fn clone(&self) -> Output

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Output

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

Formats the value using the given formatter.

impl<'__de, __A> Decode<'__de, Binary, __A> for Output

where __A: Allocator,

const IS_BITWISE_DECODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

fn decode<T0>(_1: T0) -> Result<Self, <T0 as Decoder<'__de>>::Error>

where T0: Decoder<'__de, Mode = Binary, Allocator = __A>,

Decode the current value.

impl<'__de, __A> Decode<'__de, Text, __A> for Output

where __A: Allocator,

const IS_BITWISE_DECODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

fn decode<T0>(_1: T0) -> Result<Self, <T0 as Decoder<'__de>>::Error>

where T0: Decoder<'__de, Mode = Text, Allocator = __A>,

Decode the current value.

impl<'de> Deserialize<'de> for Output

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Output

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

Formats the value using the given formatter.

impl Encode<Binary> for Output

const IS_BITWISE_ENCODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

type Encode = Output

The underlying type being encoded.

fn encode<T0>(&self, _0: T0) -> Result<(), <T0 as Encoder>::Error>

where T0: Encoder<Mode = Binary>,

Encode the given output.

fn size_hint(&self) -> Option<usize>

The number of fields in the type.

fn as_encode(&self) -> &Self::Encode

Coerce into the underlying value being encoded.

impl Encode<Text> for Output

const IS_BITWISE_ENCODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

type Encode = Output

The underlying type being encoded.

fn encode<T0>(&self, _0: T0) -> Result<(), <T0 as Encoder>::Error>

where T0: Encoder<Mode = Text>,

Encode the given output.

fn size_hint(&self) -> Option<usize>

The number of fields in the type.

fn as_encode(&self) -> &Self::Encode

Coerce into the underlying value being encoded.

impl Hash for Output

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Output

fn eq(&self, other: &Output) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Output

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryClone for Output

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 Copy for Output

impl Eq for Output

impl StructuralPartialEq for Output