vihaco_runtime (crate)

vihaco_runtime¶

vihaco_runtime

classCompositeMetadata¶source

vihaco_runtime::CompositeMetadata

Bases: Debug, Clone, StructuralPartialEq, PartialEq, Eq

Rust struct.

pub struct CompositeMetadata

Fields

Name	Type	Description
devices	&'static [DeviceMetadata]
source_symbol_aliases	&'static [SourceSymbolAliasMetadata]

source

methoddevice_by_name¶source

vihaco_runtime::CompositeMetadata::device_by_name

Signature

pub fn device_by_name(&self, name: &str) -> Option<&'static DeviceMetadata>

Parameters

Name	Type	Description
name	&str

Returns

Option<&'static DeviceMetadata>

source

methoddevices¶source

vihaco_runtime::CompositeMetadata::devices

pub fn devices(&self) -> &'static [DeviceMetadata]

Returns

&'static [DeviceMetadata]

source

methodsource_symbol_aliases¶source

vihaco_runtime::CompositeMetadata::source_symbol_aliases

Signature

pub fn source_symbol_aliases(&self) -> &'static [SourceSymbolAliasMetadata]

Returns

&'static [SourceSymbolAliasMetadata]

source

methodsource_symbol_device_code¶source

vihaco_runtime::CompositeMetadata::source_symbol_device_code

pub fn source_symbol_device_code(&self, name: &str) -> Option<u8>

Parameters

Name	Type	Description
name	&str

Returns

Option<u8>

source

methodvalidate_source_symbols¶source

vihaco_runtime::CompositeMetadata::validate_source_symbols

Signature

pub fn validate_source_symbols<I, V, Ty, Info>(&self, module: &LocalModule<I, V, Ty, Info>) -> Result<()>

Parameters

Name	Type	Description
module	&LocalModule<I, V, Ty, Info>

Returns

Result<()>

source

classComponent¶source

vihaco_runtime::Component

Rust trait.

pub trait Component: HasInstructionSet

source

classComposite¶source

vihaco_runtime::Composite

Rust trait.

pub trait Composite: HasInstructionSet

source

classGeneratedComponent¶source

vihaco_runtime::GeneratedComponent

Rust trait.

pub trait GeneratedComponent

Associated items

Name	Type	Description
Instruction	type Instruction	associated type
Message	type Message	associated type
Effect	type Effect	associated type

source

methodexecute_generated¶source

vihaco_runtime::GeneratedComponent::execute_generated

Signature

fn execute_generated(&mut self, inst: <Self as >::Instruction, msg: <Self as >::Message) -> Result<Effects<<Self as >::Effect>>

Parameters

Name	Type	Description
inst	<Self as >::Instruction
msg	<Self as >::Message

Returns

Result<Effects<<Self as >::Effect>>

source

classHasInstructionSet¶source

vihaco_runtime::HasInstructionSet

Rust trait. The instruction types exposed by a device to its two execution layers.

pub trait HasInstructionSet

Associated items

Name	Type	Description
Runtime	type Runtime	associated type. The instruction consumed by the runtime device.
Syntax	type Syntax	associated type. The instruction parsed from source syntax.

source

classMessage¶source

vihaco_runtime::Message

Rust trait.

pub trait Message: 'static

source

classObserve¶source

vihaco_runtime::Observe

Rust trait.

pub trait Observe<E: 'static>

Associated items

Name	Type	Description
Effect	type Effect: 'static	associated type
Error	type Error	associated type

source

methodobserve¶source

vihaco_runtime::Observe::observe

Signature

fn observe(&mut self, effect: &E) -> Result<Effects<<Self as >::Effect>, <Self as >::Error>

Parameters

Name	Type	Description
effect	&E

Returns

Result<Effects<<Self as >::Effect>, <Self as >::Error>

source

functionexpect_exactly_one_effect¶source

vihaco_runtime::expect_exactly_one_effect

pub fn expect_exactly_one_effect<E>(effects: Effects<E>) -> Result<E>

Parameters

Name	Type	Description
effects	Effects<E>

Returns

Result<E>

source