Forge comments module. Sprint 61.
| Tier | application |
| Role | unclassified (baselined) |
| Path | crates/application/comments |
| Edition | 2024 |
| Targets | application_comments, pg_forge_comments |
| Public items | 15 across 4 modules |
| Tests | 2 |
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
apiapi::comments_adminservicesservices::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`
| Item | What 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`
| Item | What 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`
| Item | What it is |
|---|---|
pub struct ListQuery | — |
fn router <S>() -> Router <S> where S : Clone + Send + Sync + 'static, PgPool : FromRef <S>, | — |
`services::comments`
| Item | What 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) |
| Location | crates/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.
| Crate | Tier | Optional | Only on |
|---|---|---|---|
| `application-core` | application | no | always |
| `domain-comments` | domain | no | always |
| `platform-dto` | platform | no | always |
Runtime, from outside the workspace.
| Crate | Requirement | Features | Optional | Only on |
|---|---|---|---|---|
async-trait | ^0.1 | — | no | always |
axum | ^0.7 | multipart | no | always |
chrono | ^0.4 | serde | no | always |
serde | ^1 | derive | no | always |
serde_json | ^1 | — | no | always |
sqlx | ^0.8 | runtime-tokio, postgres, chrono, uuid, json | no | always |
thiserror | ^2 | — | no | always |
tracing | ^0.1 | — | no | always |
uuid | ^1 | v4, v7, serde, js | no | always |
Development, from outside the workspace.
| Crate | Requirement | Features | Optional | Only on |
|---|---|---|---|---|
tokio | ^1 | full | no | always |
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
| Kind | Name | Source |
|---|---|---|
| lib | application_comments | `src/lib.rs` |
| test | pg_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
| Property | Evidence |
|---|---|
| async public surface | yes |
| async runtime | none detected |
| database access | yes |
| network I/O | yes |
| unsafe code | none detected |
| environment variables | yes |
No unsafe block, unsafe fn, unsafe impl or unsafe trait was found by the parser anywhere in this crate's source.
Configuration
| Variable | Read in |
|---|---|
CARGO_PKG_VERSION | src/lib.rs |
Related capabilities
No workspace crate depends on this one.
Verification
| Kind | Count |
|---|---|
| Unit tests | 1 |
| Integration tests | 1 |
| Examples | 0 |
| Doctests | 0 |
Evidence by module. How often each public module is named by something executable.
| Module | Tests | Examples | Consumers |
|---|---|---|---|
crate root | 1 | 0 | 0 |
api | 1 | 0 | 0 |
api::comments_admin | 2 | 0 | 0 |
services::comments | 6 | 0 | 0 |
What the tests establish, by name:
migrate_pending_creates_comment_threads_table—tests/pg_forge_comments.rstest_module_migrations_non_empty—src/lib.rs
Documentation coverage
| Measure | Documented | Total |
|---|---|---|
| Public items with rustdoc | 7 | 15 |
Public modules with a //! block | 3 | 4 |
pie showData
title Public items with rustdoc
"Documented" : 7
"No rustdoc detected" : 8
Metrics
| Metric | Value |
|---|---|
| Rust source files | 5 |
| Source lines | 373 |
| Code lines | 257 |
| Public API items | 15 |
| Public modules | 4 |
| Tests | 2 |
| Examples | 0 |
| Cargo features | 0 |
| Direct runtime dependencies | 12 |
| Workspace reverse dependencies | 0 |
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.