deep_causality_core 0.12.0

Core types for deep_causality crate.
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

/*
 * SPDX-License-Identifier: MIT
 * Copyright (c) 2023 - 2026. The DeepCausality Authors and Contributors. All Rights Reserved.
 */

#![cfg_attr(not(feature = "std"), no_std)]

// `alloc` is a level, not a complete configuration: it grants heap support but says nothing
// about where float math comes from. Selected on its own it leaves `deep_causality_num`
// without a math backend, which surfaces as a wall of unrelated errors deep in the
// dependency tree. Reject the incomplete combination here with an actionable message.
#[cfg(not(any(feature = "std", feature = "no-std")))]
compile_error!(
    "deep_causality_core needs one platform level: `std` or `no-std`. \
     The `alloc` feature is a level on top of those and does not select a float-math backend \
     for deep_causality_num, so it cannot be enabled on its own. \
     Use the default features for hosted targets, or \
     `--no-default-features --features no-std` for bare metal."
);

#[cfg(feature = "alloc")]
extern crate alloc;
extern crate core;

mod alias;
mod errors;
mod traits;
mod types;

// Re-export alias types
pub use crate::alias::*;

// Re-export error types
pub use crate::errors::causality_error::{CausalityError, CausalityErrorEnum};

// Re-export traits
pub use crate::traits::alternatable::Alternatable;
pub use crate::traits::alternatable_context::AlternatableContext;
pub use crate::traits::alternatable_state::AlternatableState;
pub use crate::traits::alternatable_value::AlternatableValue;
pub use crate::traits::causal_monad::CausalMonad;

// Re-export types
pub use crate::types::causal_arrow::{
    CausalArrow, CausalArrowBuilder, CausalFlowOut, CausalLift, KleisliCompose, causal_arrow,
};
pub use crate::types::causal_command::{CausalCommand, CausalCommandWitness};
pub use crate::types::causal_effect::CausalEffect;
pub use crate::types::causal_effect_propagation_process::CausalEffectPropagationProcess;
pub use crate::types::causal_effect_propagation_process::hkt::CausalEffectPropagationProcessWitness;
pub use crate::types::causal_flow::CausalFlow;
pub use crate::types::effect_log::log_effect::EffectLog;
// IO file actions (std-only): concrete `IoAction`s reading/writing files, fixing
// `Error = CausalityError`. The `IoAction` trait itself lives in `deep_causality_haft`.
#[cfg(feature = "std")]
pub use crate::types::io::{
    ReadCsv, ReadText, WriteCsv, WriteText, read_csv, read_text, write_csv, write_text,
};
pub use crate::types::propagating_effect::PropagatingEffect;
pub use crate::types::propagating_effect::hkt::PropagatingEffectWitness;
pub use crate::types::propagating_process::PropagatingProcess;
pub use crate::types::propagating_process::hkt::PropagatingProcessWitness;
pub use deep_causality_haft::Either;