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 change_executor;
27pub mod db_context;
28pub mod db_set;
29pub mod di;
30pub mod entity;
31pub mod error;
32pub mod interceptor;
33pub mod lazy;
34pub mod metadata;
35pub(crate) mod metadata_cache;
36pub mod migration;
37pub mod model_builder;
38pub mod navigation_loader;
39pub mod observability;
40pub mod provider;
41pub mod query;
42pub mod registration;
43pub mod relations;
44pub mod tracking;
45pub mod transaction;
46
47pub use async_trait;
48
49pub use inventory;
50
51pub use rust_ef_macros::{column, entity, linq, EntityType};
52
53/// Re-exports of the most commonly used types.
54pub mod prelude {
55    pub use crate::db_context::{
56        DbContext, DbContextOptions, DbContextOptionsBuilder, SaveChangesResult,
57    };
58    pub use crate::db_set::{DbSet, IDbSet};
59    pub use crate::di::DbContextServiceCollectionExt;
60    pub use crate::entity::{
61        EntityState, IEntitySnapshot, IEntityType, IFromRow, IGetKeyValues, ILazyInit,
62        INavigationSetter,
63    };
64    pub use crate::error::{EFError, EFResult};
65    pub use crate::interceptor::{
66        ISaveChangesInterceptor, SaveChangesContext, SaveChangesResultContext,
67    };
68    pub use crate::lazy::{LazyContext, LazyContextImpl, MAX_LAZY_DEPTH};
69    pub use crate::metadata::EntityTypeMeta;
70    pub use crate::metadata::NavigationMeta;
71    pub use crate::metadata::PropertyMeta;
72    pub use crate::model_builder::{
73        EntityTypeBuilder, IEntityTypeConfiguration, ModelBuilder, PropertyBuilder,
74    };
75    pub use crate::provider::DbValue;
76    pub use crate::provider::IDatabaseProvider;
77    pub use crate::provider::IsolationLevel;
78    pub use crate::query::{
79        BoolExpr, CteSpec, LinqSource, SetOpSpec, SetOperator, WindowFuncKind, WindowSpec,
80    };
81    pub use crate::registration::{EntityConfigRegistration, EntityRegistration};
82    pub use crate::relations::{BelongsTo, DeleteBehavior, HasMany, HasOne};
83    pub use crate::tracking::ChangeTracker;
84    pub use crate::transaction::{DbTransaction, ITransaction};
85    pub use rust_ef_macros::column;
86    pub use rust_ef_macros::entity;
87    pub use rust_ef_macros::linq;
88    pub use rust_ef_macros::EntityType;
89}
rust_ef/lib.rs

rust_ef/
lib.rs
