From 0ace78a01e59545953ef5be6ca6bcaa4a125a70b Mon Sep 17 00:00:00 2001
From: WriterV2 <primary-v2@protonmail.com>
Date: Sun, 4 Sep 2022 18:12:55 +0200
Subject: Add error context + comments

---
 src/works/mod.rs | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)

(limited to 'src/works/mod.rs')

diff --git a/src/works/mod.rs b/src/works/mod.rs
index 8941542..8de16d7 100644
--- a/src/works/mod.rs
+++ b/src/works/mod.rs
@@ -1,19 +1,28 @@
-use anyhow::Result;
+use anyhow::{Context, Result};
 use serde::{Deserialize, Serialize};
 
 pub mod stories;
 
+// functionality for a group of work, e.g. stories or games
 pub trait Works: for<'a> Deserialize<'a> + Serialize {
+    // create works from the corresponding JSON file,
+    // e.g. stories from stories.json
     fn new_from_file(file: std::fs::File) -> Result<Self> {
-        Ok(serde_json::from_reader(std::io::BufReader::new(file))?)
+        Ok(serde_json::from_reader(std::io::BufReader::new(&file))
+            // add error context
+            .with_context(|| format!("Failed to create works from {:?}", &file))?)
     }
 
+    // crate tera context from the group of work
+    // tera context can be accessed in HTML tera templating
     fn create_tera_context(&self) -> Result<tera::Context> {
         let mut context = tera::Context::new();
         context.insert("works", &self);
         Ok(context)
     }
 
+    // render corresponding overview HTML template
+    // with its tera context
     fn render_overview_page(
         &self,
         tera_instance: &tera::Tera,
@@ -25,6 +34,13 @@ pub trait Works: for<'a> Deserialize<'a> + Serialize {
                 format!("{}.html", filename_without_extension).as_str(),
                 &self.create_tera_context()?,
             )?,
-        )?)
+        )
+        // add error context
+        .with_context(|| {
+            format!(
+                "Failed to render overview page for {:?}",
+                filename_without_extension
+            )
+        })?)
     }
 }
-- 
cgit v1.2.3