Trait Display

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

Available on crate feature std only.

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 RecvTimeoutError

impl Display for TryRecvError

impl Display for AsciiChar

impl Display for Infallible

impl Display for FromBytesWithNulError

impl Display for IpAddr

impl Display for SocketAddr

impl Display for GetManyMutError

impl Display for VarError

impl Display for ErrorKind

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 String

impl Display for floresta_common::prelude::ioError

impl Display for RecvError

impl Display for ByteString

impl Display for UnorderedKeyError

impl Display for TryReserveError

impl Display for FromVecWithNulError

impl Display for IntoStringError

impl Display for NulError

impl Display for FromUtf8Error

impl Display for FromUtf16Error

impl Display for LayoutError

impl Display for AllocError

impl Display for TryFromSliceError

impl Display for core::ascii::EscapeDefault

impl Display for ByteStr

impl Display for BorrowError

impl Display for BorrowMutError

impl Display for CharTryFromError

impl Display for ParseCharError

impl Display for DecodeUtf16Error

impl Display for core::char::EscapeDebug

impl Display for core::char::EscapeDefault

impl Display for core::char::EscapeUnicode

impl Display for ToLowercase

impl Display for ToUppercase

impl Display for TryFromCharError

impl Display for FromBytesUntilNulError

impl Display for Ipv4Addr

impl Display for Ipv6Addr

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

impl Display for AddrParseError

impl Display for SocketAddrV4

impl Display for SocketAddrV6

impl Display for ParseFloatError

impl Display for core::num::error::ParseIntError

impl Display for TryFromIntError

impl Display for Location<'_>

impl Display for PanicInfo<'_>

impl Display for PanicMessage<'_>

impl Display for ParseBoolError

impl Display for Utf8Error

impl Display for TryFromFloatSecsError

impl Display for Backtrace

impl Display for JoinPathsError

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

impl Display for WriterPanicked

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 AccessError

impl Display for SystemTimeError

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

impl Display for Arguments<'_>

impl Display for floresta_common::prelude::fmt::Error

impl Display for AbsLockTime

impl Display for AbsLockTimeError

impl Display for Address

impl Display for AddressType

impl Display for Amount

impl Display for AnalysisError

impl Display for AnnexError

impl Display for Bip34Error

impl Display for BitcoinconsensusError

impl Display for BlockHash

impl Display for Builder

impl Display for ChainCode

impl Display for ChainHash

impl Display for CharError

impl Display for CheckedHrpstringError

impl Display for ChecksumError

impl Display for ChildNumber

impl Display for CodeLengthError

impl Display for CommandString

impl Display for CommandStringError

impl Display for CompressedPublicKey

impl Display for ContainsPrefixError

impl Display for ConversionError

impl Display for ConversionError

impl Display for DecodeError

Available on crate feature alloc only.

impl Display for DecodeError

Available on crate feature alloc only.

impl Display for DefiniteDescriptorKey

impl Display for Denomination

impl Display for DerivationPath

impl Display for DescriptorKeyParseError

impl Display for DescriptorPublicKey

impl Display for DescriptorSecretKey

impl Display for DisabledLockTimeError

impl Display for Display

impl Display for EcdsaSighashType

impl Display for ElligatorSwift

impl Display for EncodeError

Available on crate feature alloc only.

impl Display for EncodeError

impl Display for EncodeIoError

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 Error

impl Display for Error

impl Display for Error

impl Display for Error

impl Display for ExtractTxError

impl Display for Fe32

impl Display for FeeRate

Alternative will display the unit.

impl Display for FilterHash

impl Display for FilterHeader

impl Display for Fingerprint

impl Display for FromCharError

impl Display for FromHexError

impl Display for FromScriptError

impl Display for FromSliceError

impl Display for FromSliceError

impl Display for FromStrError

impl Display for FromWifError

impl Display for FutureLeafVersion

impl Display for GetKeyError

impl Display for Hash

impl Display for Hash

impl Display for Hash

impl Display for Hash

impl Display for Hash

impl Display for Hash

impl Display for Hash

impl Display for Hash

impl Display for Hash

impl Display for Hash

impl Display for Height

impl Display for Height

impl Display for HexToArrayError

impl Display for HexToBytesError

impl Display for HiddenNodesError

impl Display for Hrp

Displays the human-readable part.

If an uppercase HRP was parsed during object construction then the returned string will be in uppercase also. For a lowercase string see Self::to_lowercase.

impl Display for IncompatibleHeightError

impl Display for IncompatibleTimeError

impl Display for IncompleteBuilderError

impl Display for IncorrectChecksumError

impl Display for IndexOutOfBoundsError

impl Display for IndexOutOfBoundsError

impl Display for InputError

impl Display for InputTooLargeError

impl Display for InputsIndexError

impl Display for InvalidAddressVersionError

impl Display for InvalidBase58PayloadLengthError

impl Display for InvalidBase58PayloadLengthError

impl Display for InvalidBase58PayloadLengthError

impl Display for InvalidBufferSize

impl Display for InvalidCharError

impl Display for InvalidCharacterError

impl Display for InvalidCharacterError

impl Display for InvalidLegacyPrefixError

impl Display for InvalidLength

impl Display for InvalidLengthError

impl Display for InvalidOutputSize

impl Display for InvalidParityValue

impl Display for InvalidSighashTypeError

impl Display for InvalidWitnessVersionError

impl Display for Key

impl Display for KeyParseError

impl Display for LeafVersion

impl Display for LegacyAddressTooLongError

impl Display for LegacySighash

impl Display for LiftError

impl Display for LockTime

impl Display for LockTime

impl Display for Magic

impl Display for MerkleBlockError

impl Display for Message

impl Display for MessageSignatureError

impl Display for Midstate

impl Display for MissingDigitsError

impl Display for MissingPrefixError

impl Display for Network

impl Display for NetworkValidationError

impl Display for NonStandardSighashTypeError

impl Display for OddLengthStringError

impl Display for Opcode

impl Display for OutOfRangeError

impl Display for OutOfRangeError

impl Display for OutPoint

impl Display for OutputUpdateError

impl Display for OutputsIndexError

impl Display for P2shError

impl Display for P2wpkhError

impl Display for PaddingError

impl Display for ParseAmountError

impl Display for ParseCompressedPublicKeyError

impl Display for ParseDenominationError

impl Display for ParseError

impl Display for ParseError

impl Display for ParseHeightError

impl Display for ParseIntError

impl Display for ParseMagicError

impl Display for ParseNetworkError

impl Display for ParseOutPointError

impl Display for ParsePublicKeyError

impl Display for ParseThresholdError

impl Display for ParseTimeError

impl Display for PolicyError

impl Display for PossiblyConfusingDenominationError

impl Display for PrefixedHexError

impl Display for PrevoutsIndexError

impl Display for PrevoutsKindError

impl Display for PrevoutsSizeError

impl Display for PrivateKey

impl Display for PsbtSighashType

impl Display for PubkeyHash

impl Display for PublicKey

impl Display for PublicKey

impl Display for PushBytesError

impl Display for RelLockTime

impl Display for RelLockTimeError

impl Display for Script

impl Display for ScriptBuf

impl Display for ScriptHash

impl Display for SegwitCodeLengthError

impl Display for SegwitHrpstringError

impl Display for SegwitV0Sighash

impl Display for Sequence

impl Display for SerializedSignature

impl Display for SerializedSignature

impl Display for SerializedSignature

impl Display for ServiceFlags

impl Display for ShortId

impl Display for SigFromSliceError

impl Display for SighashError

impl Display for SighashTypeParseError

impl Display for SignError

impl Display for Signature

impl Display for Signature

impl Display for Signature

impl Display for SignedAmount

impl Display for SingleMissingOutputError

impl Display for TapLeafHash

impl Display for TapNodeHash

impl Display for TapSighash

impl Display for TapSighashType

impl Display for TapTweakHash

impl Display for TaprootBuilderError

impl Display for TaprootError

impl Display for TaprootError

impl Display for Target

impl Display for ThresholdError

impl Display for Time

impl Display for Time

impl Display for TimeOverflowError

impl Display for TooPreciseError

impl Display for TooShortError

impl Display for TryFromError

impl Display for TryFromError

impl Display for TryFromInstructionError

impl Display for TweakedPublicKey

impl Display for TxIndexOutOfRangeError

impl Display for TxMerkleNode

impl Display for TxVerifyError

impl Display for Txid

impl Display for UncheckedHrpstringError

impl Display for UncompressedPublicKeyError

impl Display for UnknownAddressTypeError

impl Display for UnknownChainHashError

impl Display for UnknownDenominationError

impl Display for UnknownHrpError

impl Display for UnknownMagicError

impl Display for UnprefixedHexError

impl Display for UtxoUpdateError

impl Display for ValidationError

impl Display for Version

impl Display for WPubkeyHash

impl Display for WScriptHash

impl Display for Weight

Alternative will display the unit.

impl Display for WitnessCommitment

impl Display for WitnessLengthError

impl Display for WitnessMerkleNode

impl Display for WitnessVersion

Prints [WitnessVersion] number (from 0 to 16) as integer, without any prefix or suffix.

impl Display for Work

impl Display for Wtxid

impl Display for XKeyIdentifier

impl Display for XOnlyPublicKey

impl Display for Xpriv

impl Display for Xpub

impl Display for dyn Expected + '_

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

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

impl<'a> Display for core::str::iter::EscapeDebug<'a>

impl<'a> Display for core::str::iter::EscapeDefault<'a>

impl<'a> Display for core::str::iter::EscapeUnicode<'a>

impl<'a> Display for DisplayByteSlice<'a>

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, 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 CannotParse<'a, T>

where T: Display + ?Sized,

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

where T: Display + ?Sized,

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

where T: Display + ?Sized,

impl<'a, const LEN: usize> Display for DisplayArray<'a, LEN>

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

where T: Display + ?Sized,

impl<'rwlock, T, R> Display for RwLockUpgradableGuard<'rwlock, T, R>

where T: Display + ?Sized,

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

where T: Display + ?Sized,

impl<'s> Display for Token<'s>

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 DecodeError<E>

where E: Debug,

impl<E> Display for SigningDataError<E>

where E: Display,

impl<F> Display for FromFn<F>

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

impl<Pk> Display for Bare<Pk>

where Pk: MiniscriptKey,

impl<Pk> Display for Descriptor<Pk>

where Pk: MiniscriptKey,

impl<Pk> Display for Pkh<Pk>

where Pk: MiniscriptKey,

impl<Pk> Display for Placeholder<Pk>

where Pk: MiniscriptKey,

impl<Pk> Display for Policy<Pk>

where Pk: MiniscriptKey,

impl<Pk> Display for Policy<Pk>

where Pk: MiniscriptKey,

impl<Pk> Display for Sh<Pk>

where Pk: MiniscriptKey,

impl<Pk> Display for TapTree<Pk>

where Pk: MiniscriptKey,

impl<Pk> Display for Tr<Pk>

where Pk: MiniscriptKey,

impl<Pk> Display for Wpkh<Pk>

where Pk: MiniscriptKey,

impl<Pk> Display for Wsh<Pk>

where Pk: MiniscriptKey,

impl<Pk, Ctx> Display for Miniscript<Pk, Ctx>

where Pk: MiniscriptKey, Ctx: ScriptContext,

impl<Pk, Ctx> Display for SortedMultiVec<Pk, Ctx>

where Pk: MiniscriptKey, Ctx: ScriptContext,

impl<Pk, Ctx> Display for Terminal<Pk, Ctx>

where Pk: MiniscriptKey, Ctx: ScriptContext,

impl<Ptr> Display for Pin<Ptr>

where Ptr: Display,

impl<T> Display for TryLockError<T>

impl<T> Display for SendTimeoutError<T>

impl<T> Display for TrySendError<T>

impl<T> Display for &T

where T: Display + ?Sized,

impl<T> Display for &mut T

where T: Display + ?Sized,

impl<T> Display for SendError<T>

impl<T> Display for floresta_common::prelude::sync::MappedMutexGuard<'_, T>

where T: Display + ?Sized,

impl<T> Display for floresta_common::prelude::sync::MappedRwLockReadGuard<'_, T>

where T: Display + ?Sized,

impl<T> Display for floresta_common::prelude::sync::MappedRwLockWriteGuard<'_, T>

where T: Display + ?Sized,

impl<T> Display for floresta_common::prelude::sync::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 floresta_common::prelude::sync::RwLockReadGuard<'_, T>

where T: Display + ?Sized,

impl<T> Display for floresta_common::prelude::sync::RwLockWriteGuard<'_, T>

where T: Display + ?Sized,

impl<T> Display for ThinBox<T>

where T: Display + ?Sized,

impl<T> Display for 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 CapacityError<T>

impl<T> Display for Hash<T>

where T: Tag,

impl<T> Display for Hmac<T>

where T: Hash,

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

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

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

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

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

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

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

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

impl<W> Display for IntoInnerError<W>

impl<const CAP: usize> Display for ArrayString<CAP>