foundation-basemodels

Foundation traits for rust-framework-workspace: UUID primary keys, timestamps, and soft delete

What it is for

# foundation-basemodels

Foundation traits for rust-framework-workspace: UUID primary keys, timestamps, and soft delete.

All domain models in the rust-framework-workspace ecosystem must implement these traits:

• HasId - UUID primary key
• Timestamped - created_at/updated_at tracking
• SoftDeletable - soft delete with deleted_at

Example

use foundation_basemodels::{HasId, Timestamped, SoftDeletable};
use uuid::Uuid;
use chrono::{DateTime, Utc};

struct Person {
id: Uuid,
name: String,
created_at: DateTime<Utc>,
updated_at: DateTime<Utc>,
deleted_at: Option<DateTime<Utc>>,
}

impl HasId for Person {
fn id(&self) -> Uuid { self.id }
}

impl Timestamped for Person {
fn created_at(&self) -> DateTime<Utc> { self.created_at }
fn updated_at(&self) -> DateTime<Utc> { self.updated_at }
}

impl SoftDeletable for Person {
fn deleted_at(&self) -> Option<DateTime<Utc>> { self.deleted_at }
}

Capabilities

Id

# foundation-basemodels

Timestamp

# foundation-basemodels

How to use it

From this crate's own rustdoc:

use foundation_basemodels::{HasId, Timestamped, SoftDeletable};
use uuid::Uuid;
use chrono::{DateTime, Utc};

struct Person {
    id: Uuid,
    name: String,
    created_at: DateTime<Utc>,
    updated_at: DateTime<Utc>,
    deleted_at: Option<DateTime<Utc>>,
}

impl HasId for Person {
    fn id(&self) -> Uuid { self.id }
}

impl Timestamped for Person {
    fn created_at(&self) -> DateTime<Utc> { self.created_at }
    fn updated_at(&self) -> DateTime<Utc> { self.updated_at }
}

impl SoftDeletable for Person {
    fn deleted_at(&self) -> Option<DateTime<Utc>> { self.deleted_at }
}

Module structure

No public modules: the crate root is its whole surface.

Public surface

`crate root`

Re-exports. Exported here, defined elsewhere.

Boundary

Depends on no other workspace tier.

Shares tier foundation with 27 other crates: foundation-audit-log, foundation-bounded-io, foundation-conversation-closure, foundation-crypto-sign, foundation-decisioning, foundation-encounter-vocabulary, foundation-fs-metadata, foundation-i18n, … (27 total).

_What this crate deliberately does NOT own is a judgment. No committed registry records one for it, so none is stated here._

Where it sits

Dependencies

Runtime, from outside the workspace.

Development, from outside the workspace.

Build. None.

Depended on by. 59 workspace crates.

Signal flow — what reaches this crate, and what it reaches.

flowchart LR
  consumers["59 consumer crates"] -->|uses| SELF
  SELF["foundation-basemodels"]
  classDef self fill:#1f883d,stroke:#1f883d,color:#fff;
  class SELF self;

Feature flags

flowchart LR
  n_default["default"]
  n_sqlx["sqlx"] --> n_dep_sqlx["dep:sqlx"]

Targets

Error model

No public error type was detected: no public item declares a type named *Error, and no public signature returns one.

Operational characteristics

No unsafe block, unsafe fn, unsafe impl or unsafe trait was found by the parser anywhere in this crate's source.

Configuration

No environment variable is read with a literal name anywhere in this crate. A variable whose key is computed at run time cannot be listed here, and is not claimed to be absent.

Related capabilities

59 workspace crates depend on this one: content-assets, content-calendar, content-calendar-recurrence, content-cms, content-directory-listing, content-notes, domain-agreements, domain-billing, domain-catalog, domain-classify, domain-comments, domain-contact, … (59 total).

Verification

Evidence by module. How often each public module is named by something executable.

What the tests establish, by name:

• test_base_model_error_display — src/lib.rs
• test_created_at_equals_updated_at_on_new — src/lib.rs
• test_created_at_returns_datetime — src/lib.rs
• test_deleted_at_none_for_active — src/lib.rs
• test_deleted_at_some_for_deleted — src/lib.rs
• test_deleted_at_timestamp_is_valid — src/lib.rs
• test_different_id_types_are_incompatible — src/lib.rs
• test_different_models_have_different_ids — src/lib.rs
• test_has_id_as_trait_object — src/lib.rs
• test_has_id_is_consistent — src/lib.rs
• test_has_id_returns_uuid — src/lib.rs
• test_is_deleted_false_for_active — src/lib.rs
• test_is_deleted_true_for_deleted — src/lib.rs
• test_newtype_id_as_uuid_ref — src/lib.rs
• test_newtype_id_copy_semantics — src/lib.rs
• test_newtype_id_derives_sqlx_type_when_feature_enabled — src/lib.rs
• test_newtype_id_display — src/lib.rs
• test_newtype_id_from_str — src/lib.rs
• test_newtype_id_from_str_invalid — src/lib.rs
• test_newtype_id_hash — src/lib.rs
• test_newtype_id_new_creates_valid_uuid — src/lib.rs
• test_newtype_id_nil — src/lib.rs
• test_newtype_id_roundtrip_uuid — src/lib.rs
• test_newtype_id_serde_roundtrip — src/lib.rs
• test_newtype_id_serde_transparent — src/lib.rs
• test_soft_deletable_as_trait_object — src/lib.rs
• test_timestamped_as_trait_object — src/lib.rs
• test_timestamps_are_consistent — src/lib.rs
• test_timestamps_are_utc — src/lib.rs
• test_updated_at_returns_datetime — src/lib.rs
• _… 13 more_

Documentation coverage

pie showData
    title Public items with rustdoc
    "Documented" : 2
    "No rustdoc detected" : 0

Metrics

pie showData
    title Public API by kind
    "type alias" : 2

pie showData
    title Rust source composition
    "Code" : 497
    "Blank or comment" : 440

Generation

Rendered by tools-corpus corpus readme from repository evidence alone, renderer schema 2, lexicon current. No model, network service or database was consulted. Regenerate with tools-corpus corpus readme --write; verify with --check.