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

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

    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);Run

## 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, }));Run

## Implementations on Foreign Types

###

`impl Display for TryFromSliceError`

[src]

####

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

[src]

###

`impl Display for Utf8Lossy`

[src]

####

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

[src]

## Implementors

###

`impl Display for VarError`

[src]

####

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

[src]

###

`impl Display for IpAddr`

[src]

####

`fn fmt(&self, fmt: &mut Formatter) -> Result`

[src]

###

`impl Display for SocketAddr`

[src]

####

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

[src]

###

`impl Display for ParseError`

[src]

####

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

[src]

###

`impl Display for RecvTimeoutError`

[src]

####

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

[src]

###

`impl Display for TryRecvError`

[src]

####

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

[src]

###

`impl Display for bool`

[src]

####

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

[src]

###

`impl Display for char`

[src]

####

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

[src]

###

`impl Display for f32`

[src]

####

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

[src]

###

`impl Display for f64`

[src]

####

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

[src]

###

`impl Display for i128`

[src]

####

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

[src]

###

`impl Display for i16`

[src]

####

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

[src]

###

`impl Display for i32`

[src]

####

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

[src]

###

`impl Display for i64`

[src]

####

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

[src]

###

`impl Display for i8`

[src]

####

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

[src]

###

`impl Display for isize`

[src]

####

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

[src]

###

`impl Display for !`

[src]

####

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

[src]

###

`impl Display for str`

[src]

####

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

[src]

###

`impl Display for u128`

[src]

####

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

[src]

###

`impl Display for u16`

[src]

####

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

[src]

###

`impl Display for u32`

[src]

####

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

[src]

###

`impl Display for u64`

[src]

####

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

[src]

###

`impl Display for u8`

[src]

####

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

[src]

###

`impl Display for usize`

[src]

####

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

[src]

###

`impl Display for AllocErr`

[src]

####

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

[src]

###

`impl Display for CannotReallocInPlace`

[src]

####

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

[src]

###

`impl Display for LayoutErr`

[src]

####

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

[src]

###

`impl Display for BorrowError`

[src]

####

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

[src]

###

`impl Display for BorrowMutError`

[src]

####

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

[src]

###

`impl Display for CharTryFromError`

[src]

####

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

[src]

###

`impl Display for DecodeUtf16Error`

[src]

####

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

[src]

###

`impl Display for EscapeDebug`

[src]

####

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

[src]

###

`impl Display for EscapeDefault`

[src]

####

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

[src]

###

`impl Display for EscapeUnicode`

[src]

####

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

[src]

###

`impl Display for ParseCharError`

[src]

####

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

[src]

###

`impl Display for ToLowercase`

[src]

####

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

[src]

###

`impl Display for ToUppercase`

[src]

####

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

[src]

###

`impl Display for JoinPathsError`

[src]

####

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

[src]

###

`impl Display for FromBytesWithNulError`

[src]

####

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

[src]

###

`impl Display for IntoStringError`

[src]

####

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

[src]

###

`impl Display for NulError`

[src]

####

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

[src]

###

`impl Display for std::fmt::Error`

[src]

####

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

[src]

###

`impl Display for std::io::Error`

[src]

####

`fn fmt(&self, fmt: &mut Formatter) -> Result`

[src]

###

`impl Display for AddrParseError`

[src]

####

`fn fmt(&self, fmt: &mut Formatter) -> Result`

[src]

###

`impl Display for Ipv4Addr`

[src]

####

`fn fmt(&self, fmt: &mut Formatter) -> Result`

[src]

###

`impl Display for Ipv6Addr`

[src]

####

`fn fmt(&self, fmt: &mut Formatter) -> Result`

[src]

###

`impl Display for SocketAddrV4`

[src]

####

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

[src]

###

`impl Display for SocketAddrV6`

[src]

####

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

[src]

###

`impl Display for NonZeroU128`

[src]

####

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

[src]

###

`impl Display for NonZeroU16`

[src]

####

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

[src]

###

`impl Display for NonZeroU32`

[src]

####

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

[src]

###

`impl Display for NonZeroU64`

[src]

####

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

[src]

###

`impl Display for NonZeroU8`

[src]

####

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

[src]

###

`impl Display for NonZeroUsize`

[src]

####

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

[src]

###

`impl Display for ParseFloatError`

[src]

####

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

[src]

###

`impl Display for ParseIntError`

[src]

####

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

[src]

###

`impl Display for TryFromIntError`

[src]

####

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

[src]

###

`impl Display for StripPrefixError`

[src]

####

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

[src]

###

`impl Display for ExitStatus`

[src]

####

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

[src]

###

`impl Display for ParseBoolError`

[src]

####

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

[src]

###

`impl Display for Utf8Error`

[src]

####

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

[src]

###

`impl Display for FromUtf16Error`

[src]

####

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

[src]

###

`impl Display for FromUtf8Error`

[src]

####

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

[src]

###

`impl Display for String`

[src]

####

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

[src]

###

`impl Display for RecvError`

[src]

####

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

[src]

###

`impl Display for AccessError`

[src]

####

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

[src]

###

`impl Display for SystemTimeError`

[src]

####

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

[src]

###

`impl<'a> Display for Arguments<'a>`

[src]

####

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

[src]

###

`impl<'a> Display for Location<'a>`

[src]

####

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

[src]

###

`impl<'a> Display for PanicInfo<'a>`

[src]

####

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

[src]

###

`impl<'a> Display for Display<'a>`

[src]

####

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

[src]

###

`impl<'a, B> Display for Cow<'a, B> where B: Display + ToOwned + ?Sized, <B as ToOwned>::Owned: Display,`

[src]

####

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

[src]

###

`impl<'a, T> Display for &'a T where T: Display + ?Sized,`

[src]

####

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

[src]

###

`impl<'a, T> Display for &'a mut T where T: Display + ?Sized,`

[src]

####

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

[src]

###

`impl<'a, T> Display for Ref<'a, T> where T: Display + ?Sized,`

[src]

####

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

[src]

###

`impl<'a, T> Display for RefMut<'a, T> where T: Display + ?Sized,`

[src]

####

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

[src]

###

`impl<'a, T: ?Sized + Display> Display for MutexGuard<'a, T>`

[src]

####

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

[src]

###

`impl<'a, T: ?Sized + Display> Display for RwLockReadGuard<'a, T>`

[src]

####

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

[src]

###

`impl<'a, T: ?Sized + Display> Display for RwLockWriteGuard<'a, T>`

[src]

####

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

[src]

###

`impl<P> Display for Pin<P> where P: Display,`

[src]

####

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

[src]

###

`impl<T> Display for TryLockError<T>`

[src]

####

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

[src]

###

`impl<T> Display for TrySendError<T>`

[src]

####

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

[src]

###

`impl<T> Display for Box<T> where T: Display + ?Sized,`

[src]

####

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

[src]

###

`impl<T> Display for Wrapping<T> where T: Display,`

[src]

####

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

[src]

###

`impl<T> Display for Rc<T> where T: Display + ?Sized,`

[src]

####

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

[src]

###

`impl<T> Display for SendError<T>`

[src]

####

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

[src]

###

`impl<T> Display for Arc<T> where T: Display + ?Sized,`

[src]

####

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

[src]

###

`impl<T> Display for PoisonError<T>`

[src]

####

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

[src]

###

`impl<W> Display for IntoInnerError<W>`

[src]

####

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

[src]

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse 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`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)