application tier

application-comments

Forge comments module. Sprint 61.

Forge comments module. Sprint 61.

Tierapplication
Roleunclassified (baselined)
Pathcrates/application/comments
Edition2024
Targetsapplication_comments, pg_forge_comments
Public items15 across 4 modules
Tests2

What it is for

application-comments — Layer 3 module. Sprint 61.

Capabilities

CommentsModule

application-comments — Layer 3 module. Sprint 61.

Item
pub struct CommentsModule
CommentsModule :: fn new() -> Self
CommentsModule :: fn name(& self) -> & 'static str
CommentsModule :: fn version(& self) -> & 'static str
CommentsModule :: fn migrations(& self) -> Vec <MigrationSet>
CommentsModule :: async fn migrate_pending(& self, pool : & PgPool) -> Result <u32, MigrationError>

api (other)

application-comments HTTP API. Sprint 65: extracted from rust-cms-engine.

Item
fn admin_router <S>() -> Router <S> where S : Clone + Send + Sync + 'static, PgPool : FromRef <S>,

api::comments_admin (other)

Comments admin REST router.

Item
fn router <S>() -> Router <S> where S : Clone + Send + Sync + 'static, PgPool : FromRef <S>,

ListQuery

Comments admin REST router.

Item
pub struct ListQuery

services::comments (other)

Comments service — thin wrapper around

Item
async fn list_by_entity(pool : & PgPool, entity_type : & str, entity_id : Uuid,) -> Result <Vec <Comment>, CommentError>
async fn list_by_thread(pool : & PgPool, thread_id : Uuid) -> Result <Vec <Comment>, CommentError>
async fn get(pool : & PgPool, id : Uuid) -> Result <Option <Comment>, CommentError>
async fn approve(pool : & PgPool, id : Uuid) -> Result <Option <Comment>, CommentError>
async fn reject(pool : & PgPool, id : Uuid) -> Result <Option <CommentEvent>, CommentError>
async fn delete(pool : & PgPool, id : Uuid) -> Result <Option <CommentEvent>, CommentError>

How to use it

No examples/ target and no doctest in this crate's rustdoc. The tests listed under Verification are the closest executable usage.

Module structure

application_comments

flowchart TD
  n_application_comments["application_comments"]
  n_application_comments --> n_api["api"]
  n_api --> n_api__comments_admin["comments_admin"]
  n_application_comments --> n_services["services"]
  n_services --> n_services__comments["comments"]

Public surface

`crate root`

ItemWhat it is
pub struct CommentsModule
CommentsModule :: fn new() -> Self
CommentsModule :: fn name(& self) -> & 'static str
CommentsModule :: fn version(& self) -> & 'static str
CommentsModule :: fn migrations(& self) -> Vec <MigrationSet>
CommentsModule :: async fn migrate_pending(& self, pool : & PgPool) -> Result <u32, MigrationError>

`api`

ItemWhat it is
fn admin_router <S>() -> Router <S> where S : Clone + Send + Sync + 'static, PgPool : FromRef <S>,Admin moderation router for comments, generic over consumer state S

`api::comments_admin`

ItemWhat it is
pub struct ListQuery
fn router <S>() -> Router <S> where S : Clone + Send + Sync + 'static, PgPool : FromRef <S>,

`services::comments`

ItemWhat it is
async fn list_by_entity(pool : & PgPool, entity_type : & str, entity_id : Uuid,) -> Result <Vec <Comment>, CommentError>List comments attached to an entity
async fn list_by_thread(pool : & PgPool, thread_id : Uuid) -> Result <Vec <Comment>, CommentError>List comments in a specific thread.
async fn get(pool : & PgPool, id : Uuid) -> Result <Option <Comment>, CommentError>Fetch a single comment by ID.
async fn approve(pool : & PgPool, id : Uuid) -> Result <Option <Comment>, CommentError>Approve a comment from the moderation queue
async fn reject(pool : & PgPool, id : Uuid) -> Result <Option <CommentEvent>, CommentError>Reject (hide) a comment from the moderation queue
async fn delete(pool : & PgPool, id : Uuid) -> Result <Option <CommentEvent>, CommentError>Delete a comment from the moderation queue

No pub use re-exports: every item above is declared in this crate.

Boundary

Reaches into domain, platform.

Shares tier application with 120 other crates: application-agreements, application-ai, application-analytics, application-approvals, application-assessments, application-audit-log, application-auth, application-billing, … (120 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

Tier (ontology)application
Architectural role (taxonomy)unclassified (baselined)
Locationcrates/application/comments
Vocabulary in force (lexicon)current

Tier flow. Which tiers this crate's own edges cross.

flowchart LR
  n_application["application"] --> n_domain["domain"]
  n_application["application"] --> n_platform["platform"]

Dependencies

Runtime, in this workspace.

CrateTierOptionalOnly on
`application-core`applicationnoalways
`domain-comments`domainnoalways
`platform-dto`platformnoalways

Runtime, from outside the workspace.

CrateRequirementFeaturesOptionalOnly on
async-trait^0.1noalways
axum^0.7multipartnoalways
chrono^0.4serdenoalways
serde^1derivenoalways
serde_json^1noalways
sqlx^0.8runtime-tokio, postgres, chrono, uuid, jsonnoalways
thiserror^2noalways
tracing^0.1noalways
uuid^1v4, v7, serde, jsnoalways

Development, from outside the workspace.

CrateRequirementFeaturesOptionalOnly on
tokio^1fullnoalways

Build. None.

Depended on by. Nothing in this workspace.

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

flowchart LR
  SELF["application-comments"]
  SELF -->|runtime| n_application_core["application-core"]
  SELF -->|runtime| n_domain_comments["domain-comments"]
  SELF -->|runtime| n_platform_dto["platform-dto"]
  classDef self fill:#1f883d,stroke:#1f883d,color:#fff;
  class SELF self;

Feature flags

No Cargo features are defined: every capability is unconditional, so no consumer can receive a half-wired crate.

Targets

KindNameSource
libapplication_comments`src/lib.rs`
testpg_forge_comments`tests/pg_forge_comments.rs`

Error model

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

Operational characteristics

PropertyEvidence
async public surfaceyes
async runtimenone detected
database accessyes
network I/Oyes
unsafe codenone detected
environment variablesyes

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

Configuration

VariableRead in
CARGO_PKG_VERSIONsrc/lib.rs

No workspace crate depends on this one.

Verification

KindCount
Unit tests1
Integration tests1
Examples0
Doctests0

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

ModuleTestsExamplesConsumers
crate root100
api100
api::comments_admin200
services::comments600

What the tests establish, by name:

Documentation coverage

MeasureDocumentedTotal
Public items with rustdoc715
Public modules with a //! block34
pie showData
    title Public items with rustdoc
    "Documented" : 7
    "No rustdoc detected" : 8

Metrics

MetricValue
Rust source files5
Source lines373
Code lines257
Public API items15
Public modules4
Tests2
Examples0
Cargo features0
Direct runtime dependencies12
Workspace reverse dependencies0
pie showData
    title Public API by kind
    "function" : 8
    "method" : 5
    "struct" : 2
pie showData
    title Rust source composition
    "Code" : 257
    "Blank or comment" : 116

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.

All application · Manual