mercurial-scm/hg: rust/hg-core/src/errors.rs annotate

annotate rust/hg-core/src/errors.rs @ 52167:7be39c5110c9

hg-core: add a complete VFS This will be used from Python in a later change. More changes are needed in hg-core and rhg to properly clean up the APIs of the old VFS implementation but it can be done when the dust settles and we start adding more functionality to the pure Rust VFS.

author	Rapha?l Gom?s <rgomes@octobus.net>
date	Mon, 29 Jul 2024 20:47:43 +0200
parents	de317a87ea6a
children	65d516db7309

rev	line source
46598 bc08c2331f99 rust: Add a `ConfigValueParseError` variant to common errors Simon Sapin <simon.sapin@octobus.net> parents: 46485 diff changeset	1 use crate::config::ConfigValueParseError;
47407 6e49769b7f97 rhg: add exit code to HgError::Abort() Pulkit Goyal <7895pulkit@gmail.com> parents: 46797 diff changeset	2 use crate::exit_codes;
52046 de317a87ea6a rust-pathauditor: match more of Python's behavior and display messages Rapha?l Gom?s <rgomes@octobus.net> parents: 50239 diff changeset	3 use crate::utils::hg_path::HgPathError;
46438 39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	4 use std::fmt;
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	5
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	6 /// Common error cases that can happen in many different APIs
46598 bc08c2331f99 rust: Add a `ConfigValueParseError` variant to common errors Simon Sapin <simon.sapin@octobus.net> parents: 46485 diff changeset	7 #[derive(Debug, derive_more::From)]
46438 39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	8 pub enum HgError {
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	9 IoError {
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	10 error: std::io::Error,
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	11 context: IoErrorContext,
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	12 },
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	13
46485 f031fe1c6ede rhg: Abort based on config on share-safe mismatch Simon Sapin <simon.sapin@octobus.net> parents: 46483 diff changeset	14 /// A file under `.hg/` normally only written by Mercurial is not in the
f031fe1c6ede rhg: Abort based on config on share-safe mismatch Simon Sapin <simon.sapin@octobus.net> parents: 46483 diff changeset	15 /// expected format. This indicates a bug in Mercurial, filesystem
f031fe1c6ede rhg: Abort based on config on share-safe mismatch Simon Sapin <simon.sapin@octobus.net> parents: 46483 diff changeset	16 /// corruption, or hardware failure.
46438 39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	17 ///
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	18 /// The given string is a short explanation for users, not intended to be
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	19 /// machine-readable.
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	20 CorruptedRepository(String),
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	21
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	22 /// The respository or requested operation involves a feature not
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	23 /// supported by the Rust implementation. Falling back to the Python
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	24 /// implementation may or may not work.
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	25 ///
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	26 /// The given string is a short explanation for users, not intended to be
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	27 /// machine-readable.
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	28 UnsupportedFeature(String),
46485 f031fe1c6ede rhg: Abort based on config on share-safe mismatch Simon Sapin <simon.sapin@octobus.net> parents: 46483 diff changeset	29
f031fe1c6ede rhg: Abort based on config on share-safe mismatch Simon Sapin <simon.sapin@octobus.net> parents: 46483 diff changeset	30 /// Operation cannot proceed for some other reason.
f031fe1c6ede rhg: Abort based on config on share-safe mismatch Simon Sapin <simon.sapin@octobus.net> parents: 46483 diff changeset	31 ///
47407 6e49769b7f97 rhg: add exit code to HgError::Abort() Pulkit Goyal <7895pulkit@gmail.com> parents: 46797 diff changeset	32 /// The message is a short explanation for users, not intended to be
46485 f031fe1c6ede rhg: Abort based on config on share-safe mismatch Simon Sapin <simon.sapin@octobus.net> parents: 46483 diff changeset	33 /// machine-readable.
47407 6e49769b7f97 rhg: add exit code to HgError::Abort() Pulkit Goyal <7895pulkit@gmail.com> parents: 46797 diff changeset	34 Abort {
6e49769b7f97 rhg: add exit code to HgError::Abort() Pulkit Goyal <7895pulkit@gmail.com> parents: 46797 diff changeset	35 message: String,
6e49769b7f97 rhg: add exit code to HgError::Abort() Pulkit Goyal <7895pulkit@gmail.com> parents: 46797 diff changeset	36 detailed_exit_code: exit_codes::ExitCode,
49488 9f14126cfc4c rust: add support for hints in error messages Rapha?l Gom?s <rgomes@octobus.net> parents: 49174 diff changeset	37 hint: Option<String>,
47407 6e49769b7f97 rhg: add exit code to HgError::Abort() Pulkit Goyal <7895pulkit@gmail.com> parents: 46797 diff changeset	38 },
46598 bc08c2331f99 rust: Add a `ConfigValueParseError` variant to common errors Simon Sapin <simon.sapin@octobus.net> parents: 46485 diff changeset	39
bc08c2331f99 rust: Add a `ConfigValueParseError` variant to common errors Simon Sapin <simon.sapin@octobus.net> parents: 46485 diff changeset	40 /// A configuration value is not in the expected syntax.
bc08c2331f99 rust: Add a `ConfigValueParseError` variant to common errors Simon Sapin <simon.sapin@octobus.net> parents: 46485 diff changeset	41 ///
bc08c2331f99 rust: Add a `ConfigValueParseError` variant to common errors Simon Sapin <simon.sapin@octobus.net> parents: 46485 diff changeset	42 /// These errors can happen in many places in the code because values are
bc08c2331f99 rust: Add a `ConfigValueParseError` variant to common errors Simon Sapin <simon.sapin@octobus.net> parents: 46485 diff changeset	43 /// parsed lazily as the file-level parser does not know the expected type
bc08c2331f99 rust: Add a `ConfigValueParseError` variant to common errors Simon Sapin <simon.sapin@octobus.net> parents: 46485 diff changeset	44 /// and syntax of each value.
bc08c2331f99 rust: Add a `ConfigValueParseError` variant to common errors Simon Sapin <simon.sapin@octobus.net> parents: 46485 diff changeset	45 #[from]
bc08c2331f99 rust: Add a `ConfigValueParseError` variant to common errors Simon Sapin <simon.sapin@octobus.net> parents: 46485 diff changeset	46 ConfigValueParseError(ConfigValueParseError),
49174 3f86ee422095 censor: make rhg fall back to python when encountering a censored node Arseniy Alekseyev <aalekseyev@janestreet.com> parents: 48418 diff changeset	47
3f86ee422095 censor: make rhg fall back to python when encountering a censored node Arseniy Alekseyev <aalekseyev@janestreet.com> parents: 48418 diff changeset	48 /// Censored revision data.
3f86ee422095 censor: make rhg fall back to python when encountering a censored node Arseniy Alekseyev <aalekseyev@janestreet.com> parents: 48418 diff changeset	49 CensoredNodeError,
50239 491f3dd080eb dirstate: deal with read-race for pure rust code path (rhg) Pierre-Yves David <pierre-yves.david@octobus.net> parents: 49488 diff changeset	50 /// A race condition has been detected. This must be handled locally
491f3dd080eb dirstate: deal with read-race for pure rust code path (rhg) Pierre-Yves David <pierre-yves.david@octobus.net> parents: 49488 diff changeset	51 /// and not directly surface to the user.
491f3dd080eb dirstate: deal with read-race for pure rust code path (rhg) Pierre-Yves David <pierre-yves.david@octobus.net> parents: 49488 diff changeset	52 RaceDetected(String),
52046 de317a87ea6a rust-pathauditor: match more of Python's behavior and display messages Rapha?l Gom?s <rgomes@octobus.net> parents: 50239 diff changeset	53 /// An invalid path was found
de317a87ea6a rust-pathauditor: match more of Python's behavior and display messages Rapha?l Gom?s <rgomes@octobus.net> parents: 50239 diff changeset	54 Path(HgPathError),
46438 39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	55 }
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	56
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	57 /// Details about where an I/O error happened
46599 1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	58 #[derive(Debug)]
46438 39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	59 pub enum IoErrorContext {
47780 cf5f8da2244c rhg: Propagate permission errors when finding a repository Simon Sapin <simon.sapin@octobus.net> parents: 47407 diff changeset	60 /// `std::fs::metadata`
cf5f8da2244c rhg: Propagate permission errors when finding a repository Simon Sapin <simon.sapin@octobus.net> parents: 47407 diff changeset	61 ReadingMetadata(std::path::PathBuf),
46599 1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	62 ReadingFile(std::path::PathBuf),
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	63 WritingFile(std::path::PathBuf),
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	64 RemovingFile(std::path::PathBuf),
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	65 RenamingFile {
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	66 from: std::path::PathBuf,
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	67 to: std::path::PathBuf,
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	68 },
52167 7be39c5110c9 hg-core: add a complete VFS Rapha?l Gom?s <rgomes@octobus.net> parents: 52046 diff changeset	69 CopyingFile {
7be39c5110c9 hg-core: add a complete VFS Rapha?l Gom?s <rgomes@octobus.net> parents: 52046 diff changeset	70 from: std::path::PathBuf,
7be39c5110c9 hg-core: add a complete VFS Rapha?l Gom?s <rgomes@octobus.net> parents: 52046 diff changeset	71 to: std::path::PathBuf,
7be39c5110c9 hg-core: add a complete VFS Rapha?l Gom?s <rgomes@octobus.net> parents: 52046 diff changeset	72 },
46740 97ac588b6d9e rhg: Don?t make repository path absolute too early Simon Sapin <simon.sapin@octobus.net> parents: 46735 diff changeset	73 /// `std::fs::canonicalize`
97ac588b6d9e rhg: Don?t make repository path absolute too early Simon Sapin <simon.sapin@octobus.net> parents: 46735 diff changeset	74 CanonicalizingPath(std::path::PathBuf),
46483 2845892dd489 rust: Parse system and user configuration Simon Sapin <simon.sapin@octobus.net> parents: 46462 diff changeset	75 /// `std::env::current_dir`
46438 39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	76 CurrentDir,
46483 2845892dd489 rust: Parse system and user configuration Simon Sapin <simon.sapin@octobus.net> parents: 46462 diff changeset	77 /// `std::env::current_exe`
2845892dd489 rust: Parse system and user configuration Simon Sapin <simon.sapin@octobus.net> parents: 46462 diff changeset	78 CurrentExe,
46438 39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	79 }
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	80
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	81 impl HgError {
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	82 pub fn corrupted(explanation: impl Into<String>) -> Self {
46443 43d63979a75e rust: use HgError in RevlogError and Vfs Simon Sapin <simon.sapin@octobus.net> parents: 46438 diff changeset	83 // TODO: capture a backtrace here and keep it in the error value
43d63979a75e rust: use HgError in RevlogError and Vfs Simon Sapin <simon.sapin@octobus.net> parents: 46438 diff changeset	84 // to aid debugging?
43d63979a75e rust: use HgError in RevlogError and Vfs Simon Sapin <simon.sapin@octobus.net> parents: 46438 diff changeset	85 // https://doc.rust-lang.org/std/backtrace/struct.Backtrace.html
46438 39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	86 HgError::CorruptedRepository(explanation.into())
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	87 }
46462 d03b0601e0eb rhg: initial support for shared repositories Simon Sapin <simon.sapin@octobus.net> parents: 46443 diff changeset	88
d03b0601e0eb rhg: initial support for shared repositories Simon Sapin <simon.sapin@octobus.net> parents: 46443 diff changeset	89 pub fn unsupported(explanation: impl Into<String>) -> Self {
d03b0601e0eb rhg: initial support for shared repositories Simon Sapin <simon.sapin@octobus.net> parents: 46443 diff changeset	90 HgError::UnsupportedFeature(explanation.into())
d03b0601e0eb rhg: initial support for shared repositories Simon Sapin <simon.sapin@octobus.net> parents: 46443 diff changeset	91 }
47407 6e49769b7f97 rhg: add exit code to HgError::Abort() Pulkit Goyal <7895pulkit@gmail.com> parents: 46797 diff changeset	92
6e49769b7f97 rhg: add exit code to HgError::Abort() Pulkit Goyal <7895pulkit@gmail.com> parents: 46797 diff changeset	93 pub fn abort(
6e49769b7f97 rhg: add exit code to HgError::Abort() Pulkit Goyal <7895pulkit@gmail.com> parents: 46797 diff changeset	94 explanation: impl Into<String>,
6e49769b7f97 rhg: add exit code to HgError::Abort() Pulkit Goyal <7895pulkit@gmail.com> parents: 46797 diff changeset	95 exit_code: exit_codes::ExitCode,
49488 9f14126cfc4c rust: add support for hints in error messages Rapha?l Gom?s <rgomes@octobus.net> parents: 49174 diff changeset	96 hint: Option<String>,
47407 6e49769b7f97 rhg: add exit code to HgError::Abort() Pulkit Goyal <7895pulkit@gmail.com> parents: 46797 diff changeset	97 ) -> Self {
6e49769b7f97 rhg: add exit code to HgError::Abort() Pulkit Goyal <7895pulkit@gmail.com> parents: 46797 diff changeset	98 HgError::Abort {
6e49769b7f97 rhg: add exit code to HgError::Abort() Pulkit Goyal <7895pulkit@gmail.com> parents: 46797 diff changeset	99 message: explanation.into(),
6e49769b7f97 rhg: add exit code to HgError::Abort() Pulkit Goyal <7895pulkit@gmail.com> parents: 46797 diff changeset	100 detailed_exit_code: exit_code,
49488 9f14126cfc4c rust: add support for hints in error messages Rapha?l Gom?s <rgomes@octobus.net> parents: 49174 diff changeset	101 hint,
47407 6e49769b7f97 rhg: add exit code to HgError::Abort() Pulkit Goyal <7895pulkit@gmail.com> parents: 46797 diff changeset	102 }
46485 f031fe1c6ede rhg: Abort based on config on share-safe mismatch Simon Sapin <simon.sapin@octobus.net> parents: 46483 diff changeset	103 }
46438 39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	104 }
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	105
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	106 // TODO: use `DisplayBytes` instead to show non-Unicode filenames losslessly?
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	107 impl fmt::Display for HgError {
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	108 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	109 match self {
47407 6e49769b7f97 rhg: add exit code to HgError::Abort() Pulkit Goyal <7895pulkit@gmail.com> parents: 46797 diff changeset	110 HgError::Abort { message, .. } => write!(f, "{}", message),
46438 39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	111 HgError::IoError { error, context } => {
46731 3d692e724d06 rhg: Align config file parse error formatting with Python Simon Sapin <simon.sapin@octobus.net> parents: 46599 diff changeset	112 write!(f, "abort: {}: {}", context, error)
46438 39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	113 }
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	114 HgError::CorruptedRepository(explanation) => {
46735 12d59eec7f1d rhg: Align with Python on some more error messages Simon Sapin <simon.sapin@octobus.net> parents: 46731 diff changeset	115 write!(f, "abort: {}", explanation)
46438 39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	116 }
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	117 HgError::UnsupportedFeature(explanation) => {
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	118 write!(f, "unsupported feature: {}", explanation)
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	119 }
49174 3f86ee422095 censor: make rhg fall back to python when encountering a censored node Arseniy Alekseyev <aalekseyev@janestreet.com> parents: 48418 diff changeset	120 HgError::CensoredNodeError => {
3f86ee422095 censor: make rhg fall back to python when encountering a censored node Arseniy Alekseyev <aalekseyev@janestreet.com> parents: 48418 diff changeset	121 write!(f, "encountered a censored node")
3f86ee422095 censor: make rhg fall back to python when encountering a censored node Arseniy Alekseyev <aalekseyev@janestreet.com> parents: 48418 diff changeset	122 }
46797 bcdcb4423ae3 rhg: Add more conversions between error types Simon Sapin <simon.sapin@octobus.net> parents: 46740 diff changeset	123 HgError::ConfigValueParseError(error) => error.fmt(f),
50239 491f3dd080eb dirstate: deal with read-race for pure rust code path (rhg) Pierre-Yves David <pierre-yves.david@octobus.net> parents: 49488 diff changeset	124 HgError::RaceDetected(context) => {
491f3dd080eb dirstate: deal with read-race for pure rust code path (rhg) Pierre-Yves David <pierre-yves.david@octobus.net> parents: 49488 diff changeset	125 write!(f, "encountered a race condition {context}")
491f3dd080eb dirstate: deal with read-race for pure rust code path (rhg) Pierre-Yves David <pierre-yves.david@octobus.net> parents: 49488 diff changeset	126 }
52046 de317a87ea6a rust-pathauditor: match more of Python's behavior and display messages Rapha?l Gom?s <rgomes@octobus.net> parents: 50239 diff changeset	127 HgError::Path(hg_path_error) => write!(f, "{}", hg_path_error),
46438 39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	128 }
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	129 }
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	130 }
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	131
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	132 // TODO: use `DisplayBytes` instead to show non-Unicode filenames losslessly?
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	133 impl fmt::Display for IoErrorContext {
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	134 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	135 match self {
47780 cf5f8da2244c rhg: Propagate permission errors when finding a repository Simon Sapin <simon.sapin@octobus.net> parents: 47407 diff changeset	136 IoErrorContext::ReadingMetadata(path) => {
cf5f8da2244c rhg: Propagate permission errors when finding a repository Simon Sapin <simon.sapin@octobus.net> parents: 47407 diff changeset	137 write!(f, "when reading metadata of {}", path.display())
cf5f8da2244c rhg: Propagate permission errors when finding a repository Simon Sapin <simon.sapin@octobus.net> parents: 47407 diff changeset	138 }
46599 1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	139 IoErrorContext::ReadingFile(path) => {
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	140 write!(f, "when reading {}", path.display())
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	141 }
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	142 IoErrorContext::WritingFile(path) => {
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	143 write!(f, "when writing {}", path.display())
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	144 }
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	145 IoErrorContext::RemovingFile(path) => {
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	146 write!(f, "when removing {}", path.display())
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	147 }
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	148 IoErrorContext::RenamingFile { from, to } => write!(
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	149 f,
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	150 "when renaming {} to {}",
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	151 from.display(),
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	152 to.display()
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	153 ),
52167 7be39c5110c9 hg-core: add a complete VFS Rapha?l Gom?s <rgomes@octobus.net> parents: 52046 diff changeset	154 IoErrorContext::CopyingFile { from, to } => write!(
7be39c5110c9 hg-core: add a complete VFS Rapha?l Gom?s <rgomes@octobus.net> parents: 52046 diff changeset	155 f,
7be39c5110c9 hg-core: add a complete VFS Rapha?l Gom?s <rgomes@octobus.net> parents: 52046 diff changeset	156 "when copying {} to {}",
7be39c5110c9 hg-core: add a complete VFS Rapha?l Gom?s <rgomes@octobus.net> parents: 52046 diff changeset	157 from.display(),
7be39c5110c9 hg-core: add a complete VFS Rapha?l Gom?s <rgomes@octobus.net> parents: 52046 diff changeset	158 to.display()
7be39c5110c9 hg-core: add a complete VFS Rapha?l Gom?s <rgomes@octobus.net> parents: 52046 diff changeset	159 ),
46740 97ac588b6d9e rhg: Don?t make repository path absolute too early Simon Sapin <simon.sapin@octobus.net> parents: 46735 diff changeset	160 IoErrorContext::CanonicalizingPath(path) => {
97ac588b6d9e rhg: Don?t make repository path absolute too early Simon Sapin <simon.sapin@octobus.net> parents: 46735 diff changeset	161 write!(f, "when canonicalizing {}", path.display())
97ac588b6d9e rhg: Don?t make repository path absolute too early Simon Sapin <simon.sapin@octobus.net> parents: 46735 diff changeset	162 }
46731 3d692e724d06 rhg: Align config file parse error formatting with Python Simon Sapin <simon.sapin@octobus.net> parents: 46599 diff changeset	163 IoErrorContext::CurrentDir => {
3d692e724d06 rhg: Align config file parse error formatting with Python Simon Sapin <simon.sapin@octobus.net> parents: 46599 diff changeset	164 write!(f, "error getting current working directory")
3d692e724d06 rhg: Align config file parse error formatting with Python Simon Sapin <simon.sapin@octobus.net> parents: 46599 diff changeset	165 }
3d692e724d06 rhg: Align config file parse error formatting with Python Simon Sapin <simon.sapin@octobus.net> parents: 46599 diff changeset	166 IoErrorContext::CurrentExe => {
3d692e724d06 rhg: Align config file parse error formatting with Python Simon Sapin <simon.sapin@octobus.net> parents: 46599 diff changeset	167 write!(f, "error getting current executable")
3d692e724d06 rhg: Align config file parse error formatting with Python Simon Sapin <simon.sapin@octobus.net> parents: 46599 diff changeset	168 }
46438 39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	169 }
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	170 }
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	171 }
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	172
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	173 pub trait IoResultExt<T> {
46599 1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	174 /// Annotate a possible I/O error as related to a reading a file at the
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	175 /// given path.
46438 39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	176 ///
46599 1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	177 /// This allows printing something like “File not found when reading
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	178 /// example.txt” instead of just “File not found”.
46438 39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	179 ///
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	180 /// Converts a `Result` with `std::io::Error` into one with `HgError`.
46599 1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	181 fn when_reading_file(self, path: &std::path::Path) -> Result<T, HgError>;
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	182
48418 abeae090ce67 rust: Add Vfs::write_atomic Simon Sapin <simon.sapin@octobus.net> parents: 47780 diff changeset	183 fn when_writing_file(self, path: &std::path::Path) -> Result<T, HgError>;
abeae090ce67 rust: Add Vfs::write_atomic Simon Sapin <simon.sapin@octobus.net> parents: 47780 diff changeset	184
46599 1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	185 fn with_context(
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	186 self,
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	187 context: impl FnOnce() -> IoErrorContext,
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	188 ) -> Result<T, HgError>;
46438 39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	189 }
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	190
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	191 impl<T> IoResultExt<T> for std::io::Result<T> {
46599 1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	192 fn when_reading_file(self, path: &std::path::Path) -> Result<T, HgError> {
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	193 self.with_context(\|\| IoErrorContext::ReadingFile(path.to_owned()))
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	194 }
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	195
48418 abeae090ce67 rust: Add Vfs::write_atomic Simon Sapin <simon.sapin@octobus.net> parents: 47780 diff changeset	196 fn when_writing_file(self, path: &std::path::Path) -> Result<T, HgError> {
abeae090ce67 rust: Add Vfs::write_atomic Simon Sapin <simon.sapin@octobus.net> parents: 47780 diff changeset	197 self.with_context(\|\| IoErrorContext::WritingFile(path.to_owned()))
abeae090ce67 rust: Add Vfs::write_atomic Simon Sapin <simon.sapin@octobus.net> parents: 47780 diff changeset	198 }
abeae090ce67 rust: Add Vfs::write_atomic Simon Sapin <simon.sapin@octobus.net> parents: 47780 diff changeset	199
46599 1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	200 fn with_context(
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	201 self,
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	202 context: impl FnOnce() -> IoErrorContext,
1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	203 ) -> Result<T, HgError> {
46438 39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	204 self.map_err(\|error\| HgError::IoError {
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	205 error,
46599 1f55cd5b292f rust: Add a log file rotation utility Simon Sapin <simon.sapin@octobus.net> parents: 46598 diff changeset	206 context: context(),
46438 39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	207 })
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	208 }
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	209 }
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	210
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	211 pub trait HgResultExt<T> {
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	212 /// Handle missing files separately from other I/O error cases.
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	213 ///
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	214 /// Wraps the `Ok` type in an `Option`:
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	215 ///
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	216 /// * `Ok(x)` becomes `Ok(Some(x))`
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	217 /// * An I/O "not found" error becomes `Ok(None)`
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	218 /// * Other errors are unchanged
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	219 fn io_not_found_as_none(self) -> Result<Option<T>, HgError>;
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	220 }
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	221
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	222 impl<T> HgResultExt<T> for Result<T, HgError> {
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	223 fn io_not_found_as_none(self) -> Result<Option<T>, HgError> {
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	224 match self {
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	225 Ok(x) => Ok(Some(x)),
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	226 Err(HgError::IoError { error, .. })
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	227 if error.kind() == std::io::ErrorKind::NotFound =>
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	228 {
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	229 Ok(None)
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	230 }
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	231 Err(other_error) => Err(other_error),
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	232 }
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	233 }
39e9407820ac rust: Introduce an `HgError` enum for common error cases Simon Sapin <simon.sapin@octobus.net> parents: diff changeset	234 }

Mercurial > public > mercurial-scm > hg

annotate rust/hg-core/src/errors.rs @ 52167:7be39c5110c9