github/ouch
1
1
Fork 0
mirror of https://github.com/ouch-org/ouch.git synced 2025-06-07 12:05:46 +00:00
Code Issues 15 Packages Projects Releases Wiki Activity

feat: use Cow<'static, str> in FinalError (#246)

Browse Source
This commit is contained in:
Vinícius Miguel 2022-01-16 18:35:53 -03:00 committed by GitHub
parent 4b2d634ebd
commit bf9e6b7b98
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
src/error.rs
View File

@ -2,7 +2,10 @@
//! //!
//! All usage errors will pass throught the Error enum, a lot of them in the Error::Custom. //! All usage errors will pass throught the Error enum, a lot of them in the Error::Custom.
use std::fmt::{self, Display}; use std::{
borrow::Cow,
fmt::{self, Display},
};
use crate::utils::colors::*; use crate::utils::colors::*;
@ -35,15 +38,18 @@ pub enum Error {
/// Alias to std's Result with ouch's Error /// Alias to std's Result with ouch's Error
pub type Result<T> = std::result::Result<T, Error>; pub type Result<T> = std::result::Result<T, Error>;
/// A string either heap-allocated or located in static storage
pub type CowStr = Cow<'static, str>;
/// Pretty final error message for end users, crashing the program after display. /// Pretty final error message for end users, crashing the program after display.
#[derive(Clone, Debug, Default, PartialEq)] #[derive(Clone, Debug, Default, PartialEq)]
pub struct FinalError { pub struct FinalError {
/// Should be made of just one line, appears after the "\[ERROR\]" part /// Should be made of just one line, appears after the "\[ERROR\]" part
title: String, title: CowStr,
/// Shown as a unnumbered list in yellow /// Shown as a unnumbered list in yellow
details: Vec<String>, details: Vec<CowStr>,
/// Shown as green at the end to give hints on how to work around this error, if it's fixable /// Shown as green at the end to give hints on how to work around this error, if it's fixable
hints: Vec<String>, hints: Vec<CowStr>,
} }
impl Display for FinalError { impl Display for FinalError {
@ -87,21 +93,21 @@ impl Display for FinalError {
impl FinalError { impl FinalError {
/// Only constructor /// Only constructor
#[must_use] #[must_use]
pub fn with_title(title: impl ToString) -> Self { pub fn with_title(title: impl Into<CowStr>) -> Self {
Self { title: title.to_string(), details: vec![], hints: vec![] } Self { title: title.into(), details: vec![], hints: vec![] }
} }
/// Add one detail line, can have multiple /// Add one detail line, can have multiple
#[must_use] #[must_use]
pub fn detail(mut self, detail: impl ToString) -> Self { pub fn detail(mut self, detail: impl Into<CowStr>) -> Self {
self.details.push(detail.to_string()); self.details.push(detail.into());
self self
} }
/// Add one hint line, can have multiple /// Add one hint line, can have multiple
#[must_use] #[must_use]
pub fn hint(mut self, hint: impl ToString) -> Self { pub fn hint(mut self, hint: impl Into<CowStr>) -> Self {
self.hints.push(hint.to_string()); self.hints.push(hint.into());
self self
} }
} }
@ -109,19 +115,23 @@ impl FinalError {
impl fmt::Display for Error { impl fmt::Display for Error {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let err = match self { let err = match self {
Error::WalkdirError { reason } => FinalError::with_title(reason), Error::WalkdirError { reason } => FinalError::with_title(reason.to_string()),
Error::NotFound { error_title } => FinalError::with_title(error_title).detail("File not found"), Error::NotFound { error_title } => FinalError::with_title(error_title.to_string()).detail("File not found"),
Error::CompressingRootFolder => { Error::CompressingRootFolder => {
FinalError::with_title("It seems you're trying to compress the root folder.") FinalError::with_title("It seems you're trying to compress the root folder.")
.detail("This is unadvisable since ouch does compressions in-memory.") .detail("This is unadvisable since ouch does compressions in-memory.")
.hint("Use a more appropriate tool for this, such as rsync.") .hint("Use a more appropriate tool for this, such as rsync.")
} }
Error::IoError { reason } => FinalError::with_title(reason), Error::IoError { reason } => FinalError::with_title(reason.to_string()),
Error::Lz4Error { reason } => FinalError::with_title(reason), Error::Lz4Error { reason } => FinalError::with_title(reason.to_string()),
Error::AlreadyExists { error_title } => FinalError::with_title(error_title).detail("File already exists"), Error::AlreadyExists { error_title } => {
Error::InvalidZipArchive(reason) => FinalError::with_title("Invalid zip archive").detail(reason), FinalError::with_title(error_title.to_string()).detail("File already exists")
Error::PermissionDenied { error_title } => FinalError::with_title(error_title).detail("Permission denied"), }
Error::UnsupportedZipArchive(reason) => FinalError::with_title("Unsupported zip archive").detail(reason), Error::InvalidZipArchive(reason) => FinalError::with_title("Invalid zip archive").detail(*reason),
Error::PermissionDenied { error_title } => {
FinalError::with_title(error_title.to_string()).detail("Permission denied")
}
Error::UnsupportedZipArchive(reason) => FinalError::with_title("Unsupported zip archive").detail(*reason),
Error::Custom { reason } => reason.clone(), Error::Custom { reason } => reason.clone(),
}; };