collections::fmt::Display - Rust
Description: API documentation for the Rust `Display` trait in crate `collections`.
Keywords: rust, rustlang, rust-lang, Display

# Trait collections::fmt::Display 1.0.0 [−] [src]

    pub trait Display {
        fn fmt(&self, f: &mut Formatter) -> Result<(), Error>;
    }

Format trait for an empty format, `{}`.

`Display` is similar to `Debug`, but `Display` is for user-facing output, and so cannot be derived.

For more information on formatters, see the module-level documentation.

# Examples

Implementing `Display` on a type:

    use std::fmt;

    struct Point {
        x: i32,
        y: i32,
    }

    impl fmt::Display for Point {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            write!(f, "({}, {})", self.x, self.y)
        }
    }

    let origin = Point { x: 0, y: 0 };

    println!("The origin is: {}", origin);

## Required Methods

### `fn fmt(&self, f: &mut Formatter) -> Result<(), Error>`

Formats the value using the given formatter.

# Examples

    use std::fmt;

    struct Position {
        longitude: f32,
        latitude: f32,
    }

    impl fmt::Display for Position {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            write!(f, "({}, {})", self.longitude, self.latitude)
        }
    }

    assert_eq!("(1.987, 2.983)".to_owned(),
               format!("{}", Position { longitude: 1.987, latitude: 2.983, }));

## Implementors

- `impl<T> Display for Box<T> where
  T: Display + ?Sized,`
- `impl<T> Display for Rc<T> where
  T: Display + ?Sized,`
- `impl<'a, B> Display for Cow<'a, B> where
  B: Display + ToOwned + ?Sized,
  <B as ToOwned>::Owned: Display,`
- `impl Display for String`
- `impl Display for AllocErr`
- `impl<T> Display for Arc<T> where
  T: Display + ?Sized,`
- `impl Display for ParseError`
- `impl Display for FromUtf16Error`
- `impl Display for CannotReallocInPlace`
- `impl Display for FromUtf8Error`
- `impl Display for u32`
- `impl<'a, T> Display for Ref<'a, T> where
  T: Display + ?Sized,`
- `impl Display for !`
- `impl Display for isize`
- `impl Display for ParseFloatError`
- `impl Display for u64`
- `impl Display for BorrowError`
- `impl Display for u128`
- `impl Display for TryFromIntError`
- `impl Display for ParseIntError`
- `impl Display for BorrowMutError`
- `impl Display for f32`
- `impl Display for u8`
- `impl Display for i64`
- `impl<'a> Display for Arguments<'a>`
- `impl Display for EscapeDebug`
- `impl<'a, T> Display for RefMut<'a, T> where
  T: Display + ?Sized,`
- `impl Display for usize`
- `impl Display for ParseBoolError`
- `impl<'a, T> Display for &'a mut T where
  T: Display + ?Sized,`
- `impl<'a, T> Display for &'a T where
  T: Display + ?Sized,`
- `impl Display for EscapeUnicode`
- `impl Display for CharTryFromError`
- `impl Display for Error`
- `impl Display for i128`
- `impl Display for u16`
- `impl Display for i16`
- `impl Display for i8`
- `impl Display for bool`
- `impl Display for str`
- `impl<T> Display for Wrapping<T> where
  T: Display,`
- `impl Display for Utf8Error`
- `impl Display for f64`
- `impl Display for EscapeDefault`
- `impl Display for char`
- `impl Display for i32`
- `impl Display for ParseCharError`
- `impl Display for Utf8Lossy`
- `impl Display for ToUppercase`
- `impl Display for DecodeUtf16Error`
- `impl Display for ToLowercase`

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)