made-core 0.3.0

Domain core of MADE: entities, value objects, events, ports. No IO.
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

//! [`ContractRegistryPort`] — registry of [`OutputContract`]s keyed by
//! their `contract_id`.
//!
//! Mirrors [`CouncilRegistryPort`](super::CouncilRegistryPort) at the
//! verb level (`register` / `get` / `list` / `delete` / `contains`).
//! The deliberate omission is `replace`: contracts are immutable per
//! id in this slice. Updating a contract means deleting it and
//! registering a new one, which forces the caller (or operator) to
//! confront the impact on in-flight consumers explicitly.

use async_trait::async_trait;

use crate::error::DomainError;
use crate::value_objects::{OutputContract, OutputContractId};

#[async_trait]
pub trait ContractRegistryPort: Send + Sync {
    /// Store a freshly defined contract. Fails with
    /// [`DomainError::AlreadyExists`] if a contract for the same
    /// `contract_id` already exists.
    async fn register(&self, contract: OutputContract) -> Result<(), DomainError>;

    /// Fetch the contract for an id. Returns
    /// [`DomainError::NotFound`] when absent.
    async fn get(&self, contract_id: &OutputContractId) -> Result<OutputContract, DomainError>;

    /// Enumerate every registered contract. Ordering is unspecified.
    async fn list(&self) -> Result<Vec<OutputContract>, DomainError>;

    /// Remove the contract for an id. Returns
    /// [`DomainError::NotFound`] when absent.
    async fn delete(&self, contract_id: &OutputContractId) -> Result<(), DomainError>;

    /// Cheap existence check that avoids materialising the contract.
    async fn contains(&self, contract_id: &OutputContractId) -> Result<bool, DomainError>;
}