es_entity/
lib.rs

1//! A Rust library for persisting Event Sourced entities to PostgreSQL
2//!
3//! This crate simplifies Event Sourcing persistence by automatically generating type-safe
4//! queries and operations for PostgreSQL. It decouples domain logic from persistence
5//! concerns while ensuring compile-time query verification via [sqlx](https://crates.io/crates/sqlx).
6//!
7//! # Documentation
8//! - [Book](https://galoymoney.github.io/es-entity)
9//! - [Github repository](https://github.com/GaloyMoney/es-entity)
10//! - [Cargo package](https://crates.io/crates/es-entity)
11//!
12//! # Features
13//!
14//! - Store and construct from event sequences
15//! - Type-safe and compile-time verification
16//! - Simple and configurable query generation
17//! - Easy idempotency checks
18//! - Cursor-based pagination
19//! - Flexible ID types
20//! - Atomic operations
21
22#![cfg_attr(feature = "fail-on-warnings", deny(warnings))]
23#![cfg_attr(feature = "fail-on-warnings", deny(clippy::all))]
24#![forbid(unsafe_code)]
25
26pub mod context;
27pub mod error;
28pub mod events;
29pub mod idempotent;
30mod macros;
31pub mod nested;
32pub mod one_time_executor;
33pub mod operation;
34pub mod pagination;
35pub mod query;
36pub mod traits;
37
38pub mod prelude {
39    //! Convenience re-export of crates that the derive macros reference in generated code.
40
41    pub use chrono;
42    pub use serde;
43    pub use serde_json;
44    pub use sqlx;
45    pub use uuid;
46
47    #[cfg(feature = "json-schema")]
48    pub use schemars;
49
50    #[cfg(feature = "sim-time")]
51    pub use sim_time;
52}
53
54#[doc(inline)]
55pub use context::*;
56#[doc(inline)]
57pub use error::*;
58pub use es_entity_macros::EsEntity;
59pub use es_entity_macros::EsEvent;
60pub use es_entity_macros::EsRepo;
61pub use es_entity_macros::es_event_context;
62pub use es_entity_macros::expand_es_query;
63pub use es_entity_macros::retry_on_concurrent_modification;
64#[doc(inline)]
65pub use events::*;
66#[doc(inline)]
67pub use idempotent::*;
68#[doc(inline)]
69pub use nested::*;
70#[doc(inline)]
71pub use one_time_executor::*;
72#[doc(inline)]
73pub use operation::*;
74#[doc(inline)]
75pub use pagination::*;
76#[doc(inline)]
77pub use query::*;
78#[doc(inline)]
79pub use traits::*;
80
81#[cfg(feature = "graphql")]
82pub mod graphql {
83    pub use async_graphql;
84    pub use base64;
85
86    #[derive(Debug, serde::Serialize, serde::Deserialize, Clone, Copy)]
87    #[serde(transparent)]
88    pub struct UUID(crate::prelude::uuid::Uuid);
89    async_graphql::scalar!(UUID);
90    impl<T: Into<crate::prelude::uuid::Uuid>> From<T> for UUID {
91        fn from(id: T) -> Self {
92            let uuid = id.into();
93            Self(uuid)
94        }
95    }
96    impl From<&UUID> for crate::prelude::uuid::Uuid {
97        fn from(id: &UUID) -> Self {
98            id.0
99        }
100    }
101}
es_entity/lib.rs

es_entity/
lib.rs
