syren 0.6.0

A parallel Rust framework for agent-based models with ECS storage, scheduling, messaging, environments, and optional GPU execution.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

//! Errors produced while building a [`Model`](crate::model::Model).

use crate::engine::error::ECSError;
use crate::engine::types::ChannelID;

/// Errors that can occur during model construction.
#[derive(Debug, thiserror::Error)]
pub enum ModelError {
    /// ECS-level setup or scheduler validation failed.
    #[error(transparent)]
    Ecs(#[from] ECSError),

    /// Agent template registration failed.
    #[error(transparent)]
    Agent(#[from] crate::agents::AgentError),

    /// Two component columns supplied for one agent template disagreed on how
    /// many agents they describe. Every column of a template must cover the
    /// same entities.
    #[error(
        "agent template `{template}` was given columns of differing lengths: expected {expected}, found {found}"
    )]
    AgentPopulationLengthMismatch {
        /// Name of the agent template whose columns disagreed.
        template: String,
        /// Length established by the first column supplied for the template.
        expected: usize,
        /// Length of the column that disagreed with it.
        found: usize,
    },

    /// Message registration failed.
    #[cfg(feature = "messaging")]
    #[error(transparent)]
    Messaging(#[from] crate::messaging::MessagingError),

    /// Environment registration failed.
    #[error(transparent)]
    Environment(#[from] crate::environment::EnvironmentError),

    /// Default entity shards could not be created.
    #[error(transparent)]
    Spawn(#[from] crate::engine::error::SpawnError),

    /// A transient message channel crosses scheduler boundaries.
    #[error(
        "message channel {channel_id} crosses scheduler boundary from {producer_scope} to {consumer_scope}"
    )]
    CrossSchedulerMessageChannel {
        /// Channel that crossed scopes.
        channel_id: ChannelID,
        /// Scope producing the channel.
        producer_scope: String,
        /// Scope consuming the channel.
        consumer_scope: String,
    },

    /// An environment channel flows backward relative to model tick order.
    #[error(
        "environment channel {channel_id} flows backward from {producer_scope} to {consumer_scope}"
    )]
    BackwardEnvironmentChannel {
        /// Channel with invalid flow.
        channel_id: ChannelID,
        /// Scope producing the channel.
        producer_scope: String,
        /// Scope consuming the channel.
        consumer_scope: String,
    },

    /// Two sub-schedulers were registered with the same display name.
    #[error("duplicate sub-scheduler name: {name}")]
    DuplicateSubSchedulerName {
        /// Duplicate name.
        name: String,
    },

    /// A lock needed during build was poisoned.
    #[error("model build lock poisoned: {0}")]
    LockPoisoned(&'static str),
}