cuprate/types/README.md

# `cuprate-types`
Various data types shared by Cuprate.

- [1. File Structure](#1-file-structure)
    - [1.1 `src/`](#11-src)

---

## 1. File Structure
A quick reference of the structure of the folders & files in `cuprate-types`.

Note that `lib.rs/mod.rs` files are purely for re-exporting/visibility/lints, and contain no code. Each sub-directory has a corresponding `mod.rs`.

### 1.1 `src/`
The top-level `src/` files.

| File                | Purpose |
|---------------------|---------|
| `service.rs`        | Types used in database requests; `enum {Request,Response}`
| `types.rs`          | Various general types used by Cuprate