From d2d7170a9c0f8e643c20a61864426a6aeb98c480 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Kat=20March=C3=A1n?= <kzm@zkat.tech>
Date: Sun, 30 Jun 2019 23:20:01 -0700
Subject: [PATCH] doc(error): document all errors

---
 src/errors.rs | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/src/errors.rs b/src/errors.rs
index 9c9cd5a..393801e 100644
--- a/src/errors.rs
+++ b/src/errors.rs
@@ -9,20 +9,31 @@ use walkdir;
 /// Error type returned by all API calls.
 #[derive(Fail, Debug)]
 pub enum Error {
+    /// Returned when an index or content entry could not be found during
+    /// lookup.
     #[fail(display = "not found")]
     NotFound,
+    /// Returned when an integrity check has failed.
     #[fail(display = "integrity check failed")]
     IntegrityError,
+    /// Returned when a size check has failed.
     #[fail(display = "size check failed")]
     SizeError,
+    /// Returned when there's an std::io::Error.
     #[fail(display = "{}", _0)]
     Io(#[fail(cause)] io::Error),
+    /// Returned when there's an error with changing uid/gid on an entry.
     #[fail(display = "{}", _0)]
     Chownr(#[fail(cause)] chownr::Error),
+    /// Returned when there's an issue with metadata (de)serialization.
     #[fail(display = "{}", _0)]
     SerdeJson(#[fail(cause)] serde_json::error::Error),
+    /// Returned when a content entry could not be moved to its final
+    /// destination.
     #[fail(display = "{}", _0)]
     PersistError(#[fail(cause)] tempfile::PersistError),
+    /// Returned when something went wrong while traversing the index during
+    /// `cacache::ls`.
     #[fail(display = "{}", _0)]
     WalkDir(#[fail(cause)] walkdir::Error),
 }