From 96f824863c354e818b712d532e64c34502f8c9f5 Mon Sep 17 00:00:00 2001
From: Wojciech Kozlowski <wk@wojciechkozlowski.eu>
Date: Wed, 29 Mar 2023 15:31:42 +0900
Subject: [PATCH] Documentation fixes

---
 src/database/json.rs | 8 +++++---
 src/database/mod.rs  | 8 +++++---
 src/lib.rs           | 2 +-
 3 files changed, 11 insertions(+), 7 deletions(-)

diff --git a/src/database/json.rs b/src/database/json.rs
index fa635fc..7807a90 100644
--- a/src/database/json.rs
+++ b/src/database/json.rs
@@ -5,21 +5,23 @@ use std::path::Path;
 use serde::de::DeserializeOwned;
 use serde::Serialize;
 
-use crate::database::DatabaseRead;
-
-use super::DatabaseWrite;
+use crate::database::{DatabaseRead, DatabaseWrite};
 
+/// A JSON file database.
 pub struct DatabaseJson {
     database_file: File,
 }
 
 impl DatabaseJson {
+    /// Create a read-only database instance. If the JSON file does not exist, an error is returned.
     pub fn reader(path: &Path) -> Result<Self, std::io::Error> {
         Ok(Self {
             database_file: File::open(path)?,
         })
     }
 
+    /// Create a write-only database instance. If the file does not exist, it is created, if it does
+    /// exist, it is truncated.
     pub fn writer(path: &Path) -> Result<Self, std::io::Error> {
         Ok(Self {
             database_file: File::create(path)?,
diff --git a/src/database/mod.rs b/src/database/mod.rs
index dec7541..5dff0b3 100644
--- a/src/database/mod.rs
+++ b/src/database/mod.rs
@@ -1,15 +1,17 @@
 use serde::de::DeserializeOwned;
 use serde::Serialize;
 
-mod json;
+pub mod json;
 
-trait DatabaseRead {
+/// Trait for database reads.
+pub trait DatabaseRead {
     fn read<D>(&mut self, collection: &mut D) -> Result<(), std::io::Error>
     where
         D: DeserializeOwned;
 }
 
-trait DatabaseWrite {
+/// Trait for database writes.
+pub trait DatabaseWrite {
     fn write<S>(&mut self, collection: &S) -> Result<(), std::io::Error>
     where
         S: Serialize;
diff --git a/src/lib.rs b/src/lib.rs
index fcb9201..88c424c 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -3,7 +3,7 @@
 use serde::{Deserialize, Serialize};
 use uuid::Uuid;
 
-mod database;
+pub mod database;
 
 /// [MusicBrainz Identifier](https://musicbrainz.org/doc/MusicBrainz_Identifier) (MBID).
 pub type Mbid = Uuid;