Trait ockam_core::compat::fmt::Display
1.0.0 · source · pub trait Display {
// Required method
fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>;
}
Expand description
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§
sourcefn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>
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)",
format!("{}", Position { longitude: 1.987, latitude: 2.983, }));
Implementors§
impl Display for Method
impl Display for Status
impl Display for RouteError
impl Display for ockam_core::compat::io::ErrorKind
impl Display for IpAddr
impl Display for SocketAddr
impl Display for BernoulliError
impl Display for WeightedError
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 crossbeam_channel::err::RecvTimeoutError
impl Display for crossbeam_channel::err::TryRecvError
impl Display for FromHexError
impl Display for log::Level
impl Display for log::LevelFilter
impl Display for MietteError
impl Display for Type
impl Display for Array
impl Display for opentelemetry::common::Value
impl Display for opentelemetry::global::error_handler::Error
impl Display for LogError
impl Display for MetricsError
impl Display for TraceError
impl Display for Aggregation
impl Display for opentelemetry_sdk::runtime::TrySendError
impl Display for regex_syntax::ast::Ast
Print a display representation of this Ast.
This does not preserve any of the original whitespace formatting that may have originally been present in the concrete syntax from which this Ast was generated.
This implementation uses constant stack space and heap space proportional
to the size of the Ast
.
impl Display for regex_syntax::ast::Ast
Print a display representation of this Ast.
This does not preserve any of the original whitespace formatting that may have originally been present in the concrete syntax from which this Ast was generated.
This implementation uses constant stack space and heap space proportional
to the size of the Ast
.
impl Display for regex_syntax::ast::ErrorKind
impl Display for regex_syntax::ast::ErrorKind
impl Display for regex_syntax::error::Error
impl Display for regex_syntax::error::Error
impl Display for regex_syntax::hir::ErrorKind
impl Display for regex_syntax::hir::ErrorKind
impl Display for regex::error::Error
impl Display for serde_json::value::Value
impl Display for CollectionAllocErr
impl Display for strum::ParseError
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 ockam_core::api::Error
impl Display for Id
impl Display for ErrorCode
impl Display for FlowControlId
impl Display for Address
impl Display for AddressParseError
impl Display for Any
impl Display for ockam_core::Error
impl Display for OpenTelemetryContext
impl Display for ProtocolId
impl Display for Route
impl Display for TransportMessage
impl Display for TransportType
impl Display for ockam_core::compat::io::Error
impl Display for WriterPanicked
impl Display for AddrParseError
impl Display for Ipv4Addr
impl Display for Ipv6Addr
Write an Ipv6Addr, conforming to the canonical style described by RFC 5952.
impl Display for SocketAddrV4
impl Display for SocketAddrV6
impl Display for ReadError
impl Display for ockam_core::compat::rand::Error
impl Display for String
impl Display for SystemTimeError
impl Display for TryFromFloatSecsError
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 core::array::TryFromSliceError
impl Display for core::ascii::EscapeDefault
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 FromBytesWithNulError
impl Display for core::num::dec2flt::ParseFloatError
impl Display for ParseIntError
impl Display for core::num::error::TryFromIntError
impl Display for Location<'_>
impl Display for PanicInfo<'_>
impl Display for ParseBoolError
impl Display for Utf8Error
impl Display for Backtrace
impl Display for JoinPathsError
impl Display for std::ffi::os_str::Display<'_>
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 crossbeam_channel::err::RecvError
impl Display for SelectTimeoutError
impl Display for TrySelectError
impl Display for futures_channel::mpsc::SendError
impl Display for futures_channel::mpsc::TryRecvError
impl Display for Canceled
impl Display for EnterError
impl Display for SpawnError
impl Display for Aborted
impl Display for getrandom::error::Error
impl Display for GlobError
impl Display for Pattern
Show the original glob pattern.
impl Display for PatternError
impl Display for log::ParseLevelError
impl Display for SetLoggerError
impl Display for InstallError
impl Display for miette::eyreish::Report
impl Display for MietteDiagnostic
impl Display for Int
impl Display for minicbor::data::TryFromIntError
impl Display for UnknownTag
impl Display for minicbor::decode::error::Error
impl Display for EndOfArray
impl Display for EndOfSlice
impl Display for Infix
impl Display for Prefix
impl Display for Suffix
impl Display for num_traits::ParseFloatError
impl Display for Baggage
impl Display for BaggageMetadata
impl Display for Key
impl Display for StringValue
impl Display for SpanId
impl Display for TraceId
impl Display for FloatIsNan
impl Display for regex_automata::error::Error
impl Display for regex_automata::meta::error::BuildError
impl Display for regex_automata::nfa::thompson::error::BuildError
impl Display for GroupInfoError
impl Display for UnicodeWordBoundaryError
impl Display for PatternIDError
impl Display for SmallIndexError
impl Display for StateIDError
impl Display for MatchError
impl Display for PatternSetInsertError
impl Display for DeserializeError
impl Display for SerializeError
impl Display for regex_syntax::ast::Error
impl Display for regex_syntax::ast::Error
impl Display for regex_syntax::hir::Error
impl Display for regex_syntax::hir::Error
impl Display for regex_syntax::hir::Hir
Print a display representation of this Hir.
The result of this is a valid regular expression pattern string.
This implementation uses constant stack space and heap space proportional
to the size of the Hir
.
impl Display for regex_syntax::hir::Hir
Print a display representation of this Hir.
The result of this is a valid regular expression pattern string.
This implementation uses constant stack space and heap space proportional
to the size of the Hir
.