rust_ef/
lib.rs

1//! # Rust Entity Framework (rust-ef)
2//!
3//! An EFCore-inspired ORM for Rust, bringing the familiar
4//! DbContext/DbSet/EntityType patterns to the Rust ecosystem.
5//!
6//! ## Example
7//!
8//! ```rust,ignore
9//! use rust_ef::prelude::*;
10//!
11//! #[derive(EntityType)]
12//! #[table("blogs")]
13//! pub struct Blog {
14//!     #[primary_key]
15//!     #[auto_increment]
16//!     pub blog_id: i32,
17//!     #[required]
18//!     #[max_length(200)]
19//!     pub url: String,
20//!     pub rating: i32,
21//!     #[navigation]
22//!     pub posts: HasMany<Post>,
23//! }
24//! ```
25
26pub mod cascade;
27pub mod change_executor;
28pub mod db_context;
29pub mod db_set;
30pub mod dependency_graph;
31pub mod di;
32pub mod entity;
33pub mod error;
34pub mod interceptor;
35pub mod lazy;
36pub mod metadata;
37pub(crate) mod metadata_cache;
38pub mod migration;
39pub mod model_builder;
40pub mod navigation_loader;
41pub mod observability;
42pub mod provider;
43pub mod query;
44pub mod registration;
45pub mod relations;
46pub mod tracking;
47pub mod transaction;
48
49pub use async_trait;
50
51pub use inventory;
52
53pub use rust_ef_macros::{column, entity, linq, EntityType};
54
55/// Re-exports of the most commonly used types.
56pub mod prelude {
57    pub use crate::db_context::{
58        DbContext, DbContextOptions, DbContextOptionsBuilder, SaveChangesResult,
59    };
60    pub use crate::db_set::{DbSet, IDbSet};
61    pub use crate::di::DbContextServiceCollectionExt;
62    pub use crate::entity::{
63        EntityState, IEntitySnapshot, IEntityType, IFromRow, IGetKeyValues, ILazyInit,
64        INavigationSetter,
65    };
66    pub use crate::error::{EFError, EFErrorCode, EFResult};
67    pub use crate::interceptor::{
68        ISaveChangesInterceptor, SaveChangesContext, SaveChangesResultContext,
69    };
70    pub use crate::lazy::{LazyContext, LazyContextImpl, MAX_LAZY_DEPTH};
71    pub use crate::metadata::EntityTypeMeta;
72    pub use crate::metadata::NavigationMeta;
73    pub use crate::metadata::PropertyMeta;
74    pub use crate::model_builder::{
75        EntityTypeBuilder, IEntityTypeConfiguration, ModelBuilder, PropertyBuilder,
76    };
77    pub use crate::provider::DbValue;
78    pub use crate::provider::IDatabaseProvider;
79    pub use crate::provider::IsolationLevel;
80    pub use crate::query::{
81        BoolExpr, CteSpec, LinqSource, SetOpSpec, SetOperator, WindowFuncKind, WindowSpec,
82    };
83    pub use crate::registration::{EntityConfigRegistration, EntityRegistration};
84    pub use crate::relations::{BelongsTo, DeleteBehavior, HasMany, HasOne};
85    pub use crate::tracking::ChangeTracker;
86    pub use crate::transaction::{DbTransaction, ITransaction};
87    pub use rust_ef_macros::column;
88    pub use rust_ef_macros::entity;
89    pub use rust_ef_macros::linq;
90    pub use rust_ef_macros::EntityType;
91}
rust_ef/lib.rs

rust_ef/
lib.rs
