Crate total_space

Explore the total space of states of communicating finite state machines.

This is just the API reference documentation; see the README for an overview and links to example code.

Macros

action_change_and_sends

A macro for an action changing the state and sending several messages.

action_sends

A macro for an action sending several messages.

activity_alternatives

A macro for activity processing one out several payloads.

agent_index

A macro for accessing a global variable containing agent index.

agent_states_iter

A macro for iterating on all the agents of some type in a configuration.

agents_count

A macro for accessing the number of agent instances.

assert_configuration_hash_entry_size

A macro for static assertion on the size of the configuration hash entry.

declare_agent_index

A macro for declaring a global variable containing singleton agent index.

declare_agent_indices

A macro for declaring a global variable containing agent indices.

declare_agent_type_data

A macro for declaring a global variable containing an agent type.

impl_enum_data

A macro for implementing data-like (states, payload) for an enum.

impl_struct_data

A macro for implementing data-like (states, payload) for a struct with a name field.

index_type

A macro for implementing some IndexLike type.

init_agent_index

A macro for initializing a global variable containing singleton agent index.

init_agent_indices

A macro for initializing a global variable containing singleton agent index.

init_agent_type_data

A macro for initializing a global variable containing an agent type.

messages_iter

A macro for iterating on all the in-flight messages configuration.

reaction_alternatives

A macro for one of several alternatives reaction.

Structs

AgentTypeData

The data we need to implement an agent type.

Configuration

A complete system configuration.

ContainerOf1TypeData

The data we need to implement an container agent type.

ContainerOf2TypeData

The data we need to implement an container agent type.

Message

A message in-flight between agents.

MessageIndex

The type of the index of a message in the configuration.

Model

A complete model.

Enums

Action

Specify an action the agent may take when handling an event.

Activity

The reaction of an agent to time passing.

Emit

A message sent by an agent as part of an alternative action triggered by some event.

Instances

Specify the number of agent instances to use.

Invalid

An indicator that something is invalid.

MessageOrder

Possible way to order a message.

Reaction

The reaction of an agent to receiving a message.

Constants

MAX_COUNT

The maximal number of alternative actions in a reaction, payloads in an activity or emitted messages within an action.

Traits

AgentInstances

A trait partially describing some agent instances of the same type.

AgentState

A trait for a single agent state.

AgentType

A trait fully describing some agent instances of the same type.

ClapModel

Execute operations on a model using clap commands.

ContainerOf1State

A trait for a container agent state.

ContainerOf2State

A trait for a container agent state.

IndexLike

A trait for anything we use as a zero-based index.

MetaModel

Allow querying the model’s meta-parameters for public types.

Name

A trait for data having a short name.

PartType

Allow access to state of parts.

Functions

add_clap

Add clap commands and flags to a clap application.

model_size

Parse the model size parameter.

Trait Aliases

DataLike

A trait for data we pass around in the model.

KeyLike

A trait for anything we use as a key in a HashMap.

Named

A trait for data that has a short name (via AsRef<&'static str>) and a full display name (via Display).