aboutsummaryrefslogtreecommitdiffstats
path: root/rust/HACKING.md
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2018-09-10 19:37:36 -0700
committerBryan Newbold <bnewbold@robocracy.org>2018-09-10 19:37:36 -0700
commitdd0dbc45a0c0aad0819203431d374cbd93cce58f (patch)
treef9a8fb6e8eea82d54f561fb89472d16a4f287505 /rust/HACKING.md
parent1aa49b2c613178f17a2cb6e85a22f183a1c81947 (diff)
parent60b070103e80a83e062a57cefd0ba0a84fc3a4c0 (diff)
downloadfatcat-x-attic-cockroach.tar.gz
fatcat-x-attic-cockroach.zip
Merge branch 'master' into cockroachx-attic-cockroachcockroach
Manually resolve conflicts in: rust/migrations/2018-05-12-001226_init/up.sql
Diffstat (limited to 'rust/HACKING.md')
-rw-r--r--rust/HACKING.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/rust/HACKING.md b/rust/HACKING.md
index 622a4b5a..0dde5058 100644
--- a/rust/HACKING.md
+++ b/rust/HACKING.md
@@ -8,11 +8,11 @@ swagger API spec on one side and the SQL schema on the other.
- `./src/database_schema.rs`: autogenerated per-table Diesel schemas
- `./src/database_models.rs`: hand- and macro-generated Rust structs matching
Diesel schemas, and a small number of row-level helpers
-- `./src/database_entity_crud.rs`: "struct-relational-mapping"; trait
+- `./src/api_entity_crud.rs`: "struct-relational-mapping"; trait
implementations of CRUD (create, read, update, delete) actions for each
entity model, hitting the database (and building on `database_model` structs)
- `./src/api_server.rs`: one function for each API endpoint, with rust-style
- arguments and return types. mostly calls in to `database_entity_crud`.
+ arguments and return types. mostly calls in to `api_entity_crud`.
- `./src/api_wrappers.rs`: hand- and macro-generated wrapper functions, one per
API endpoint, that map between API request and return types, and
rust-idiomatic request and return types (plus API models).