Trait Display

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

Format trait for an empty format, {}.

Implementing this trait for a type will automatically implement the ToString trait for the type, allowing the usage of the .to_string() method. Prefer implementing the Display trait for a type, rather than ToString.

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.

Internationalization

Because a type can only have one Display implementation, it is often preferable to only implement Display when there is a single most “obvious” way that values can be formatted as text. This could mean formatting according to the “invariant” culture and “undefined” locale, or it could mean that the type display is designed for a specific culture/locale, such as developer logs.

If not all values have a justifiably canonical textual format or if you want to support alternative formats not covered by the standard set of possible formatting traits, the most flexible approach is display adapters: methods like str::escape_default or Path::display which create a wrapper implementing Display to output the specific display format.

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 };

assert_eq!(format!("The origin is: {origin}"), "The origin is: (0, 0)");

Required Methods

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

Formats the value using the given formatter.

Errors

This function should return Err if, and only if, the provided Formatter returns Err. String formatting is considered an infallible operation; this function only returns a Result because writing to the underlying stream might fail and it must provide a way to propagate the fact that an error has occurred back up the stack.

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)",
    format!("{}", Position { longitude: 1.987, latitude: 2.983, }),
);

Implementors

impl Display for kvarn::encryption::Error

impl Display for IpAddr

impl Display for SocketAddr

impl Display for ErrorKind

impl Display for ToCompactStringError

impl Display for AsciiChar

impl Display for Infallible

impl Display for VarError

impl Display for std::sync::mpsc::RecvTimeoutError

impl Display for std::sync::mpsc::TryRecvError

impl Display for log::Level

impl Display for log::LevelFilter

impl Display for Variant

impl Display for BernoulliError

impl Display for WeightedError

impl Display for bool

impl Display for char

impl Display for f32

impl Display for f64

impl Display for i8

impl Display for i16

impl Display for i32

impl Display for i64

impl Display for i128

impl Display for isize

impl Display for !

impl Display for str

impl Display for u8

impl Display for u16

impl Display for u32

impl Display for u64

impl Display for u128

impl Display for usize

impl Display for Id

impl Display for OffsetDateTime

impl Display for Mime

impl Display for CompactString

impl Display for HeaderName

impl Display for Method

impl Display for StatusCode

Formats the status code, including the canonical reason.

Example

assert_eq!(format!("{}", StatusCode::OK), "200 OK");

impl Display for Uri

impl Display for Query<'_>

impl Display for QueryPair<'_>

impl Display for Arguments<'_>

impl Display for kvarn::prelude::utils::prelude::fmt::Error

impl Display for InvalidHeaderName

impl Display for InvalidHeaderValue

impl Display for MaxSizeReached

impl Display for ToStrError

impl Display for kvarn::prelude::utils::prelude::io::Error

impl Display for WriterPanicked

impl Display for kvarn::prelude::utils::prelude::net::AddrParseError

impl Display for Ipv4Addr

impl Display for Ipv6Addr

Writes an Ipv6Addr, conforming to the canonical style described by RFC 5952.

impl Display for SocketAddrV4

impl Display for SocketAddrV6

impl Display for ParseBoolError

impl Display for Utf8Error

impl Display for Authority

impl Display for InvalidUri

impl Display for InvalidUriParts

impl Display for PathAndQuery

impl Display for Scheme

impl Display for Drain<'_>

impl Display for ReserveError

impl Display for Utf16Error

impl Display for AllocError

impl Display for LayoutError

impl Display for kvarn::prelude::utils::prelude::compact_str::core::array::TryFromSliceError

impl Display for kvarn::prelude::utils::prelude::compact_str::core::ascii::EscapeDefault

impl Display for BorrowError

impl Display for BorrowMutError

impl Display for CharTryFromError

impl Display for DecodeUtf16Error

impl Display for kvarn::prelude::utils::prelude::compact_str::core::char::EscapeDebug

impl Display for kvarn::prelude::utils::prelude::compact_str::core::char::EscapeDefault

impl Display for kvarn::prelude::utils::prelude::compact_str::core::char::EscapeUnicode

impl Display for ParseCharError

impl Display for ToLowercase

impl Display for ToUppercase

impl Display for TryFromCharError

impl Display for FromBytesUntilNulError

impl Display for FromBytesWithNulError

impl Display for ParseFloatError

impl Display for kvarn::prelude::utils::prelude::compact_str::core::num::ParseIntError

impl Display for kvarn::prelude::utils::prelude::compact_str::core::num::TryFromIntError

impl Display for Location<'_>

impl Display for PanicInfo<'_>

impl Display for PanicMessage<'_>

impl Display for TryFromFloatSecsError

impl Display for UnorderedKeyError

impl Display for alloc::collections::TryReserveError

impl Display for FromVecWithNulError

impl Display for IntoStringError

impl Display for NulError

impl Display for FromUtf8Error

impl Display for FromUtf16Error

impl Display for String

impl Display for Backtrace

impl Display for JoinPathsError

impl Display for std::ffi::os_str::Display<'_>

impl Display for PanicHookInfo<'_>

impl Display for std::path::Display<'_>

impl Display for StripPrefixError

impl Display for ExitStatus

impl Display for ExitStatusError

impl Display for std::sync::mpsc::RecvError

impl Display for AccessError

impl Display for SystemTimeError

impl Display for FixedBitSet

impl Display for CompressError

impl Display for flate2::mem::DecompressError

impl Display for getrandom::error::Error

impl Display for log::ParseLevelError

impl Display for SetLoggerError

impl Display for FromStrError

impl Display for serde::de::value::Error

impl Display for uuid::error::Error

impl Display for Braced

impl Display for Hyphenated

impl Display for Simple

impl Display for Urn

impl Display for Uuid

impl Display for rand::rngs::adapter::read::ReadError

impl Display for rand_core::error::Error

impl Display for Aborted

impl Display for AcquireError

impl Display for AddrParseError

impl Display for AnyDelimiterCodecError

impl Display for ApplicationClose

impl Display for Canceled

impl Display for CapacityError

impl Display for CloseCode

impl Display for CloseFrame

impl Display for ClosedStream

impl Display for Code

impl Display for CollectionAllocErr

impl Display for ComponentRange

impl Display for ConfigError

impl Display for ConnectError

impl Display for ConnectionClose

impl Display for ConnectionError

impl Display for ConnectionError

impl Display for ConnectionId

impl Display for ContentSizeError

impl Display for Control

impl Display for ConversionRange

impl Display for Data

impl Display for Date

impl Display for DecodeError

impl Display for DecodeSliceError

impl Display for DecompressError

Available on crate feature with-alloc only.

impl Display for DifferentVariant

impl Display for Dir

impl Display for Duration

The format returned by this implementation is not stable and must not be relied upon.

By default this produces an exact, full-precision printout of the duration. For a concise, rounded printout instead, you can use the .N format specifier:

let duration = Duration::new(123456, 789011223);
println!("{duration:.3}");

For the purposes of this implementation, a day is exactly 24 hours and a minute is exactly 60 seconds.

impl Display for EarlyDataError

impl Display for Elapsed

impl Display for EncodeError

impl Display for EncodeSliceError

impl Display for EncryptError

impl Display for EnterError

impl Display for Error

impl Display for Error

impl Display for Error

impl Display for Error

impl Display for Error

impl Display for Error

impl Display for Error

impl Display for Error

impl Display for Error

impl Display for Error

impl Display for Error

impl Display for Error

impl Display for Error

impl Display for Error

impl Display for Field

impl Display for FieldSet

impl Display for FileTime

impl Display for FinishError

impl Display for Format

impl Display for Frame

impl Display for IndeterminateOffset

impl Display for InvalidBufferSize

impl Display for InvalidDnsNameError

impl Display for InvalidFormatDescription

impl Display for InvalidLength

impl Display for InvalidMethod

impl Display for InvalidOutputSize

impl Display for InvalidStatusCode

impl Display for InvalidStreamId

impl Display for InvalidVariant

impl Display for JoinError

impl Display for KeyRejected

impl Display for KeyRejected

impl Display for LengthDelimitedCodecError

impl Display for Level

impl Display for LevelFilter

impl Display for LinesCodecError

impl Display for Message

impl Display for Month

impl Display for NoInitialCipherSuite

impl Display for OpCode

impl Display for OtherError

impl Display for PacketDecodeError

impl Display for Parse

impl Display for ParseAlphabetError

impl Display for ParseError

impl Display for ParseFromDescription

impl Display for ParseIntError

impl Display for ParseLevelError

impl Display for ParseLevelFilterError

impl Display for PredicateError

impl Display for PrimitiveDateTime

impl Display for ProtocolError

impl Display for PushError

impl Display for ReadError

impl Display for ReadError

impl Display for ReadError

impl Display for ReadExactError

impl Display for ReadToEndError

impl Display for ReadableError

impl Display for Reason

impl Display for RecvError

impl Display for RecvError

impl Display for RecvError

impl Display for RecvError

impl Display for RecvTimeoutError

impl Display for ResetError

impl Display for RetryError

impl Display for RetryError

impl Display for ReuniteError

impl Display for ReuniteError

impl Display for SelectTimeoutError

impl Display for SendDatagramError

impl Display for SendDatagramError

impl Display for SendDatagramError

impl Display for SendError

impl Display for SendStreamError

impl Display for SetGlobalDefaultError

impl Display for SpawnError

impl Display for StoppedError

impl Display for StreamId

impl Display for StreamId

impl Display for SubProtocolError

impl Display for Time

impl Display for TlsError

impl Display for TryAcquireError

impl Display for TryCurrentError

impl Display for TryFromIntError

impl Display for TryFromParsed

impl Display for TryFromSliceError

impl Display for TryLockError

impl Display for TryRecvError

impl Display for TryRecvError

impl Display for TryRecvError

impl Display for TryRecvError

impl Display for TryRecvError

impl Display for TryReserveError

impl Display for TrySelectError

impl Display for Unspecified

impl Display for Unspecified

impl Display for UnsupportedOperationError

impl Display for UrlError

impl Display for UtcOffset

impl Display for Utf8Bytes

impl Display for VarInt

impl Display for VarIntBoundsExceeded

impl Display for VerifierBuilderError

impl Display for Weekday

impl Display for WriteError

impl Display for WriteError

impl Display for dyn Value

impl<'a> Display for Unexpected<'a>

impl<'a> Display for kvarn::prelude::utils::prelude::str::EscapeDebug<'a>

impl<'a> Display for kvarn::prelude::utils::prelude::str::EscapeDefault<'a>

impl<'a> Display for kvarn::prelude::utils::prelude::str::EscapeUnicode<'a>

impl<'a> Display for EscapeAscii<'a>

impl<'a> Display for Name<'a>

impl<'a> Display for BufReadDecoderError<'a>

impl<'a> Display for DecodeError<'a>

impl<'a> Display for PercentEncode<'a>

impl<'a> Display for ValueSet<'a>

impl<'a> Display for dyn Expected + 'a

impl<'a, 'e, E> Display for Base64Display<'a, 'e, E>

where E: Engine,

impl<'a, G> Display for Dot<'a, G>

where G: IntoEdgeReferences + IntoNodeReferences + NodeIndexable + GraphProp, <G as Data>::EdgeWeight: Display, <G as Data>::NodeWeight: Display,

impl<'a, K, V> Display for std::collections::hash::map::OccupiedError<'a, K, V>

where K: Debug, V: Debug,

impl<'a, K, V, A> Display for alloc::collections::btree::map::entry::OccupiedError<'a, K, V, A>

where K: Debug + Ord, V: Debug, A: Allocator + Clone,

impl<'a, K, V, S, A> Display for OccupiedError<'a, K, V, S, A>

where K: Debug, V: Debug, A: Allocator,

impl<'a, K, V, S, A> Display for OccupiedError<'a, K, V, S, A>

where K: Debug, V: Debug, A: Allocator,

impl<'a, K, V, T> Display for MappedRef<'a, K, V, T>

where K: Eq + Hash, T: Display,

impl<'a, R, G, T> Display for MappedReentrantMutexGuard<'a, R, G, T>

where R: RawMutex + 'a, G: GetThreadId + 'a, T: Display + 'a + ?Sized,

impl<'a, R, G, T> Display for ReentrantMutexGuard<'a, R, G, T>

where R: RawMutex + 'a, G: GetThreadId + 'a, T: Display + 'a + ?Sized,

impl<'a, R, T> Display for MappedMutexGuard<'a, R, T>

where R: RawMutex + 'a, T: Display + 'a + ?Sized,

impl<'a, R, T> Display for MappedRwLockReadGuard<'a, R, T>

where R: RawRwLock + 'a, T: Display + 'a + ?Sized,

impl<'a, R, T> Display for MappedRwLockWriteGuard<'a, R, T>

where R: RawRwLock + 'a, T: Display + 'a + ?Sized,

impl<'a, R, T> Display for MutexGuard<'a, R, T>

where R: RawMutex + 'a, T: Display + 'a + ?Sized,

impl<'a, R, T> Display for RwLockReadGuard<'a, R, T>

where R: RawRwLock + 'a, T: Display + 'a + ?Sized,

impl<'a, R, T> Display for RwLockUpgradableReadGuard<'a, R, T>

where R: RawRwLockUpgrade + 'a, T: Display + 'a + ?Sized,

impl<'a, R, T> Display for RwLockWriteGuard<'a, R, T>

where R: RawRwLock + 'a, T: Display + 'a + ?Sized,

impl<'a, T> Display for MappedMutexGuard<'a, T>

where T: Display + ?Sized,

impl<'a, T> Display for RwLockMappedWriteGuard<'a, T>

where T: Display + ?Sized,

impl<'a, T> Display for RwLockReadGuard<'a, T>

where T: Display + ?Sized,

impl<'a, T> Display for RwLockWriteGuard<'a, T>

where T: Display + ?Sized,

impl<'s, T> Display for SliceVec<'s, T>

where T: Display,

impl<A> Display for ArrayVec<A>

where A: Array, <A as Array>::Item: Display,

impl<A> Display for TinyVec<A>

where A: Array, <A as Array>::Item: Display,

impl<B> Display for Cow<'_, B>

where B: Display + ToOwned + ?Sized, <B as ToOwned>::Owned: Display,

impl<E> Display for Report<E>

where E: Error,

impl<E> Display for Err<E>

where E: Debug,

impl<F> Display for FromFn<F>

where F: Fn(&mut Formatter<'_>) -> Result<(), Error>,

impl<I> Display for Error<I>

where I: Display,

The Display implementation allows the std::error::Error implementation

impl<I> Display for VerboseError<I>

where I: Display,

Available on crate feature alloc only.

impl<O> Display for F32<O>

where O: ByteOrder,

impl<O> Display for F64<O>

where O: ByteOrder,

impl<O> Display for I16<O>

where O: ByteOrder,

impl<O> Display for I32<O>

where O: ByteOrder,

impl<O> Display for I64<O>

where O: ByteOrder,

impl<O> Display for I128<O>

where O: ByteOrder,

impl<O> Display for U16<O>

where O: ByteOrder,

impl<O> Display for U32<O>

where O: ByteOrder,

impl<O> Display for U64<O>

where O: ByteOrder,

impl<O> Display for U128<O>

where O: ByteOrder,

impl<Ptr> Display for Pin<Ptr>

where Ptr: Display,

impl<S> Display for Ascii<S>

where S: Display,

impl<S> Display for UniCase<S>

where S: Display,

impl<T> Display for std::sync::mpmc::error::SendTimeoutError<T>

impl<T> Display for std::sync::mpsc::TrySendError<T>

impl<T> Display for std::sync::poison::TryLockError<T>

impl<T> Display for &T

where T: Display + ?Sized,

impl<T> Display for &mut T

where T: Display + ?Sized,

impl<T> Display for CleanDebug<'_, T>

where T: Display + ?Sized,

impl<T> Display for Port<T>

impl<T> Display for kvarn::prelude::utils::prelude::compact_str::core::cell::Ref<'_, T>

where T: Display + ?Sized,

impl<T> Display for RefMut<'_, T>

where T: Display + ?Sized,

impl<T> Display for NonZero<T>

where T: ZeroablePrimitive + Display,

impl<T> Display for Saturating<T>

where T: Display,

impl<T> Display for Wrapping<T>

where T: Display,

impl<T> Display for ThinBox<T>

where T: Display + ?Sized,

impl<T> Display for std::sync::mpsc::SendError<T>

impl<T> Display for std::sync::mutex::MappedMutexGuard<'_, T>

where T: Display + ?Sized,

impl<T> Display for std::sync::mutex::MutexGuard<'_, T>

where T: Display + ?Sized,

impl<T> Display for PoisonError<T>

impl<T> Display for ReentrantLockGuard<'_, T>

where T: Display + ?Sized,

impl<T> Display for std::sync::rwlock::MappedRwLockReadGuard<'_, T>

where T: Display + ?Sized,

impl<T> Display for std::sync::rwlock::MappedRwLockWriteGuard<'_, T>

where T: Display + ?Sized,

impl<T> Display for std::sync::rwlock::RwLockReadGuard<'_, T>

where T: Display + ?Sized,

impl<T> Display for std::sync::rwlock::RwLockWriteGuard<'_, T>

where T: Display + ?Sized,

impl<T> Display for Arc<T>

where T: Display + ?Sized,

impl<T> Display for AsyncFdTryNewError<T>

impl<T> Display for CachePadded<T>

where T: Display,

impl<T> Display for DisplayValue<T>

where T: Display,

impl<T> Display for MutexGuard<'_, T>

where T: Display + ?Sized,

impl<T> Display for OwnedMutexGuard<T>

where T: Display + ?Sized,

impl<T> Display for OwnedRwLockWriteGuard<T>

where T: Display + ?Sized,

impl<T> Display for PollSendError<T>

impl<T> Display for ReuniteError<T>

impl<T> Display for SendError<T>

impl<T> Display for SendError<T>

impl<T> Display for SendError<T>

impl<T> Display for SendError<T>

impl<T> Display for SendTimeoutError<T>

Available on crate feature time only.

impl<T> Display for SendTimeoutError<T>

impl<T> Display for SetError<T>

impl<T> Display for ShardedLockReadGuard<'_, T>

where T: Display + ?Sized,

impl<T> Display for ShardedLockWriteGuard<'_, T>

where T: Display + ?Sized,

impl<T> Display for TrySendError<T>

impl<T> Display for TrySendError<T>

impl<T> Display for TrySendError<T>

impl<T> Display for Unalign<T>

where T: Unaligned + Display,

impl<T, A> Display for kvarn::prelude::Arc<T, A>

where T: Display + ?Sized, A: Allocator,

impl<T, A> Display for Box<T, A>

where T: Display + ?Sized, A: Allocator,

impl<T, A> Display for Rc<T, A>

where T: Display + ?Sized, A: Allocator,

impl<T, B> Display for Ref<B, [T]>

where B: ByteSlice, T: FromBytes, [T]: Display,

impl<T, B> Display for Ref<B, T>

where B: ByteSlice, T: FromBytes + Display,

impl<T, E> Display for TryChunksError<T, E>

where E: Display,

impl<T, E> Display for TryReadyChunksError<T, E>

where E: Display,

impl<T, Item> Display for ReuniteError<T, Item>

impl<T, U> Display for OwnedMappedMutexGuard<T, U>

where U: Display + ?Sized, T: ?Sized,

impl<T, U> Display for OwnedRwLockMappedWriteGuard<T, U>

where U: Display + ?Sized, T: ?Sized,

impl<T, U> Display for OwnedRwLockReadGuard<T, U>

where U: Display + ?Sized, T: ?Sized,

impl<W> Display for IntoInnerError<W>

impl<const MIN: i8, const MAX: i8> Display for RangedI8<MIN, MAX>

impl<const MIN: i16, const MAX: i16> Display for RangedI16<MIN, MAX>

impl<const MIN: i32, const MAX: i32> Display for RangedI32<MIN, MAX>

impl<const MIN: i64, const MAX: i64> Display for RangedI64<MIN, MAX>

impl<const MIN: i128, const MAX: i128> Display for RangedI128<MIN, MAX>

impl<const MIN: isize, const MAX: isize> Display for RangedIsize<MIN, MAX>

impl<const MIN: u8, const MAX: u8> Display for RangedU8<MIN, MAX>

impl<const MIN: u16, const MAX: u16> Display for RangedU16<MIN, MAX>

impl<const MIN: u32, const MAX: u32> Display for RangedU32<MIN, MAX>

impl<const MIN: u64, const MAX: u64> Display for RangedU64<MIN, MAX>

impl<const MIN: u128, const MAX: u128> Display for RangedU128<MIN, MAX>

impl<const MIN: usize, const MAX: usize> Display for RangedUsize<MIN, MAX>

impl<const N: usize> Display for GetManyMutError<N>

impl<const SIZE: usize> Display for WriteBuffer<SIZE>