Forge notes module — notes + tagging for any model via generic foreign keys.
| Tier | application |
| Role | unclassified (baselined) |
| Path | crates/application/notes |
| Edition | 2024 |
| Targets | application_notes, pg_forge_notes |
| Public items | 7 across 0 modules |
| Tests | 2 |
What it is for
application-notes — notes + tagging for any entity.
B-009: before this, migrations() returned Vec::new() and migrate_pending returned Ok(0) while ignoring the pool, so notes, tags, and object_tags (crates/content/notes/migrations/001_notes.sql, 002_tags.sql, 003_object_tags.sql) were never created by anything that actually called this module's own migration path. All three tables are self-contained (no FKs outside this library crate's own schema), so migrate_pending needs no cross-module bootstrap. Mirrors application-encounters's and application-calendar's pattern exactly. permission_codes() was already wired (Tier B).
Capabilities
NotesModule
application-notes — notes + tagging for any entity.
| Item |
|---|
pub struct NotesModule |
NotesModule :: fn new() -> Self |
NotesModule :: fn name(& self) -> & 'static str |
NotesModule :: fn version(& self) -> & 'static str |
NotesModule :: fn migrations(& self) -> Vec <MigrationSet> |
NotesModule :: async fn migrate_pending(& self, pool : & PgPool) -> std::result::Result <u32, MigrationError> |
NotesModule :: fn permission_codes(& self) -> Vec <String> |
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
No public modules: the crate root is its whole surface.
Public surface
`crate root`
| Item | What it is |
|---|---|
pub struct NotesModule | — |
NotesModule :: fn new() -> Self | — |
NotesModule :: fn name(& self) -> & 'static str | — |
NotesModule :: fn version(& self) -> & 'static str | — |
NotesModule :: fn migrations(& self) -> Vec <MigrationSet> | — |
NotesModule :: async fn migrate_pending(& self, pool : & PgPool) -> std::result::Result <u32, MigrationError> | — |
NotesModule :: fn permission_codes(& self) -> Vec <String> | — |
No pub use re-exports: every item above is declared in this crate.
Boundary
Reaches into content.
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/notes |
| Vocabulary in force (lexicon) | current |
Tier flow. Which tiers this crate's own edges cross.
flowchart LR n_application["application"] --> n_content["content"]
Dependencies
Runtime, in this workspace.
| Crate | Tier | Optional | Only on |
|---|---|---|---|
| `application-core` | application | no | always |
| `content-notes` | content | no | always |
Runtime, from outside the workspace.
| Crate | Requirement | Features | Optional | Only on |
|---|---|---|---|---|
async-trait | ^0.1 | — | no | always |
sqlx | ^0.8 | runtime-tokio, postgres, chrono, uuid, json | 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-notes"] SELF -->|runtime| n_application_core["application-core"] SELF -->|runtime| n_content_notes["content-notes"] 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_notes | `src/lib.rs` |
| test | pg_forge_notes | `tests/pg_forge_notes.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 | none detected |
| 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 |
What the tests establish, by name:
migrate_pending_creates_notes_table—tests/pg_forge_notes.rstest_module_migrations_non_empty—src/lib.rs
Documentation coverage
| Measure | Documented | Total |
|---|---|---|
| Public items with rustdoc | 0 | 7 |
Public modules with a //! block | 0 | 0 |
pie showData
title Public items with rustdoc
"Documented" : 0
"No rustdoc detected" : 7
Metrics
| Metric | Value |
|---|---|
| Rust source files | 1 |
| Source lines | 90 |
| Code lines | 66 |
| Public API items | 7 |
| Public modules | 0 |
| Tests | 2 |
| Examples | 0 |
| Cargo features | 0 |
| Direct runtime dependencies | 4 |
| Workspace reverse dependencies | 0 |
pie showData
title Public API by kind
"method" : 6
"struct" : 1
pie showData
title Rust source composition
"Code" : 66
"Blank or comment" : 24
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.