display -> display_chain (#195)

Fixes #180

Author: Yamakaky

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Unreleased
 
+- [Rename `ChanedError::display` to `display_chain`](https://github.com/brson/error-chain/issues/180)
 - [Add a new method for `Error`: `chain_err`.](https://github.com/brson/error-chain/pull/141)
 - [Allow `chain_err` to be used on `Option<T>`](https://github.com/brson/error-chain/pull/156)
 - [Add support for creating an error chain on boxed trait errors (`Box<Error>`)](https://github.com/brson/error-chain/pull/156)

examples/quickstart.rs

@@ -46,17 +46,17 @@ fn main() {
 
 // The above main gives you maximum control over how the error is
 // formatted. If you don't care (i.e. you want to display the full
-// error during an assert) you can just call the `display` method
+// error during an assert) you can just call the `display_chain` method
 // on the error object
 #[allow(dead_code)]
 fn alternative_main() {
     if let Err(ref e) = run() {
         use std::io::Write;
-        use error_chain::ChainedError; // trait which holds `display`
+        use error_chain::ChainedError; // trait which holds `display_chain`
         let stderr = &mut ::std::io::stderr();
         let errmsg = "Error writing to stderr";
 
-        writeln!(stderr, "{}", e.display()).expect(errmsg);
+        writeln!(stderr, "{}", e.display_chain()).expect(errmsg);
         ::std::process::exit(1);
     }
 }

src/lib.rs

@@ -61,7 +61,7 @@
 //!
 //! * Instead of defining the custom `Error` type as an enum, it is a
 //!   struct containing an `ErrorKind` (which defines the
-//!   `description` and `display` methods for the error), an opaque,
+//!   `description` and `display_chain` methods for the error), an opaque,
 //!   optional, boxed `std::error::Error + Send + 'static` object
 //!   (which defines the `cause`, and establishes the links in the
 //!   error chain), and a `Backtrace`.
@@ -390,7 +390,7 @@
 //!
 //! ```
 //! # #[macro_use] extern crate error_chain;
-//! use error_chain::ChainedError;  // for e.display()
+//! use error_chain::ChainedError;  // for e.display_chain()
 //!
 //! error_chain! {
 //!     errors {
@@ -414,7 +414,7 @@
 //! assert_eq!(e.to_string(), "invalid toolchain name: 'xyzzy'");
 //!
 //! // Get the full cause and backtrace:
-//! println!("{}", e.display().to_string());
+//! println!("{}", e.display_chain().to_string());
 //! //     Error: invalid toolchain name: 'xyzzy'
 //! //     Caused by: invalid digit found in string
 //! //     stack backtrace:
@@ -550,8 +550,8 @@ pub trait ChainedError: error::Error + Send + 'static {
     /// context of this error.
     ///
     /// The full cause chain and backtrace, if present, will be printed.
-    fn display<'a>(&'a self) -> Display<'a, Self> {
-        Display(self)
+    fn display_chain<'a>(&'a self) -> DisplayChain<'a, Self> {
+        DisplayChain(self)
     }
 
     /// Extends the error chain with a new entry.
@@ -573,9 +573,9 @@ pub trait ChainedError: error::Error + Send + 'static {
 
 /// A struct which formats an error for output.
 #[derive(Debug)]
-pub struct Display<'a, T: 'a + ?Sized>(&'a T);
+pub struct DisplayChain<'a, T: 'a + ?Sized>(&'a T);
 
-impl<'a, T> fmt::Display for Display<'a, T>
+impl<'a, T> fmt::Display for DisplayChain<'a, T>
     where T: ChainedError
 {
     fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {

src/quick_main.rs

@@ -47,7 +47,7 @@ macro_rules! quick_main {
             ::std::process::exit(match $main() {
                 Ok(ret) => $crate::ExitCode::code(ret),
                 Err(ref e) => {
-                    write!(&mut ::std::io::stderr(), "{}", $crate::ChainedError::display(e))
+                    write!(&mut ::std::io::stderr(), "{}", $crate::ChainedError::display_chain(e))
                         .expect("Error writing to stderr");
 
                     1