deep_causality_haft 0.5.2

HKT traits for for the 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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

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

use crate::{
    Effect3Unbound, Effect4Unbound, Effect5Unbound, HKT4Unbound, HKT5Unbound, HKT6Unbound,
};

// ----------------------------------------------------
// Unbound Monad Effect Traits (Parametric Effects | Arity 3)
// ----------------------------------------------------

/// Monadic logic for Parametric Effects (Arity 3 Unbound).
///
/// Enables state transitions (`S1 -> S2`) within the effect system.
pub trait MonadEffect3Unbound<E: Effect3Unbound> {
    /// Lifts a pure value into the parametric effect container.
    /// The state `S` remains unchanged (`S -> S`).
    fn pure<S, T>(value: T) -> <E::HktWitness as HKT4Unbound>::Type<E::Fixed1, S, S, T>;

    /// Indexed Bind: Chains computations while tracking state transitions.
    /// `S1 -> S2` (first step) AND `S2 -> S3` (second step) => `S1 -> S3` (result).
    fn ibind<S1, S2, S3, T, U, Func>(
        effect: <E::HktWitness as HKT4Unbound>::Type<E::Fixed1, S1, S2, T>,
        f: Func,
    ) -> <E::HktWitness as HKT4Unbound>::Type<E::Fixed1, S1, S3, U>
    where
        Func: FnMut(T) -> <E::HktWitness as HKT4Unbound>::Type<E::Fixed1, S2, S3, U>;
}

// ----------------------------------------------------
// Unbound Monad Effect Traits (Parametric Effects | Arity 4)
// ----------------------------------------------------

/// Monadic logic for Parametric Effects (Arity 4 Unbound).
///
/// Enables state transitions (`S1 -> S2`) within the effect system.
#[allow(clippy::type_complexity)]
pub trait MonadEffect4Unbound<E: Effect4Unbound> {
    /// Lifts a pure value into the parametric effect container.
    /// The state `S` remains unchanged (`S -> S`).
    fn pure<S, T>(value: T) -> <E::HktWitness as HKT5Unbound>::Type<E::Fixed1, E::Fixed2, S, S, T>;

    /// Indexed Bind: Chains computations while tracking state transitions.
    fn ibind<S1, S2, S3, T, U, Func>(
        effect: <E::HktWitness as HKT5Unbound>::Type<E::Fixed1, E::Fixed2, S1, S2, T>,
        f: Func,
    ) -> <E::HktWitness as HKT5Unbound>::Type<E::Fixed1, E::Fixed2, S1, S3, U>
    where
        Func: FnMut(T) -> <E::HktWitness as HKT5Unbound>::Type<E::Fixed1, E::Fixed2, S2, S3, U>;
}

// ----------------------------------------------------
// Unbound Monad Effect Traits (Parametric Effects | Arity 5)
// ----------------------------------------------------

/// Monadic logic for Parametric Effects (Arity 5 Unbound).
///
/// Enables state transitions (`S1 -> S2`) within the effect system.
#[allow(clippy::type_complexity)]
pub trait MonadEffect5Unbound<E: Effect5Unbound> {
    /// Lifts a pure value into the parametric effect container.
    /// The state `S` remains unchanged (`S -> S`).
    fn pure<S, T>(
        value: T,
    ) -> <E::HktWitness as HKT6Unbound>::Type<E::Fixed1, E::Fixed2, E::Fixed3, S, S, T>;

    /// Indexed Bind: Chains computations while tracking state transitions.
    fn ibind<S1, S2, S3, T, U, Func>(
        effect: <E::HktWitness as HKT6Unbound>::Type<E::Fixed1, E::Fixed2, E::Fixed3, S1, S2, T>,
        f: Func,
    ) -> <E::HktWitness as HKT6Unbound>::Type<E::Fixed1, E::Fixed2, E::Fixed3, S1, S3, U>
    where
        Func: FnMut(
            T,
        ) -> <E::HktWitness as HKT6Unbound>::Type<
            E::Fixed1,
            E::Fixed2,
            E::Fixed3,
            S2,
            S3,
            U,
        >;
}