Trait bones_framework::asset::prelude::bones_utils::prelude::alloc::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§

1.0.0 · source

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

Trait bones_framework::asset::prelude::bones_utils::prelude::alloc::fmt::DisplayCopy item path

§Internationalization

§Examples

Required Methods§

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

§Errors

§Examples

Implementors§

impl Display for GgrsError

impl Display for GamepadAxis

impl Display for GamepadButton

impl Display for LogFileError

impl Display for EcsRefBorrowError

impl Display for CompileErrorKind

impl Display for ParseErrorKind

impl Display for LexError

impl Display for ClosureError

impl Display for InvalidTableKey

impl Display for PrototypeError

impl Display for StaticError

impl Display for VMError

impl Display for BinaryOperatorError

impl Display for HexColorError

impl Display for CollectionAllocErr

impl Display for LabeledIdCreateError

impl Display for LabledIdParseError

impl Display for bones_framework::asset::prelude::bones_utils::prelude::futures::io::ErrorKind

impl Display for AsciiChar

impl Display for Infallible

impl Display for IpAddr

impl Display for core::net::socket_addr::SocketAddr

impl Display for VarError

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

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

impl Display for bincode::error::ErrorKind

impl Display for FromHexError

impl Display for IpNet

impl Display for log::Level

impl Display for log::LevelFilter

impl Display for serde_json::value::Value

impl Display for url::parser::ParseError

impl Display for SyntaxViolation

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 bones_framework::glam::Affine2

impl Display for bones_framework::glam::Affine3A

impl Display for bones_framework::glam::BVec2

impl Display for bones_framework::glam::BVec3

impl Display for bones_framework::glam::BVec3A

impl Display for bones_framework::glam::BVec4

impl Display for bones_framework::glam::BVec4A

impl Display for bones_framework::glam::DAffine2

impl Display for bones_framework::glam::DAffine3

impl Display for bones_framework::glam::DMat2

impl Display for bones_framework::glam::DMat3

impl Display for bones_framework::glam::DMat4

impl Display for bones_framework::glam::DQuat

impl Display for bones_framework::glam::DVec2

impl Display for bones_framework::glam::DVec3

impl Display for bones_framework::glam::DVec4

impl Display for bones_framework::glam::I64Vec2

impl Display for bones_framework::glam::I64Vec3

Trait bones_framework::asset::prelude::bones_utils::prelude::alloc::fmt::Display