Crate rstm_state 

The state module provides abstractions and implementations for managing state within the rstm framework.

Modules

error

This module defines the custom error type for handling various state-related errors.

traits

the traits for defining the types of states and their behaviors

types

various types and type aliases for working with state

Macros

state

the [state!] macro is a simple helper macro to create a State instance.

Structs

State

State is a generalized state implementation, representing the state of a system or object.

Enums

HaltTag

Halter

Halter extends the State by allowing for an ‘imaginary’ state that is not actually part of the machine’s state space.

StateError

the various errors that can occur in the state module

Traits

DisplayState

DisplayState is a trait that extends the RawState trait to include symbolic operations and implementations.

Halt

The Halt trait establishes a common interface for any haltable type;

HaltState

HashState

The HashState trait extends the RawState trait to include hashing capabilities, streamlining the process of using states as keys in hash maps or sets.

NumState

The NumState trait extends the RawState trait to include numeric operations.

RawState

RawState is a trait describing objects capable of being used as states in our library. The trait contains a single associated trait, the context, or inner value of the state.

StateRepr

The StateRepr trait defines a common interface for any implemented representations of state.

Stated

StdState

The StdState trait extends the base RawState trait to include additional traits commonly used alongside the state.

Type Aliases

AnyState

A type alias for a State whose inner value is the dynamically sized type of a boxed Any.

MaybeState

A type alias for a State whose inner value is a core::mem::MaybeUninit of generic type Q.

MutState

A type alias for a State whose inner value is a mutable reference to a generic type Q.

PtrState

A type alias for a State whose inner value is a raw pointer to a generic type Q

RefState

A type alias for a State whose inner value is a reference to a generic type Q.

Result

A type alias for a Result that uses the custom [Error] type

ShardState

SharedState