source2_demo::proto::prost::alloc::fmt

Trait Debug

1.36.0

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

Expand description

? formatting.

Debug should format the output in a programmer-facing, debugging context.

Generally speaking, you should just derive a Debug implementation.

When used with the alternate format specifier #?, the output is pretty-printed.

For more information on formatters, see the module-level documentation.

This trait can be used with #[derive] if all fields implement Debug. When derived for structs, it will use the name of the struct, then {, then a comma-separated list of each field’s name and Debug value, then }. For enums, it will use the name of the variant and, if applicable, (, then the Debug values of the fields, then ).

§Stability

Derived Debug formats are not stable, and so may change with future Rust versions. Additionally, Debug implementations of types provided by the standard library (std, core, alloc, etc.) are not stable, and may also change with future Rust versions.

§Examples

Deriving an implementation:

#[derive(Debug)]
struct Point {
    x: i32,
    y: i32,
}

let origin = Point { x: 0, y: 0 };

assert_eq!(
    format!("The origin is: {origin:?}"),
    "The origin is: Point { x: 0, y: 0 }",
);

Manually implementing:

use std::fmt;

struct Point {
    x: i32,
    y: i32,
}

impl fmt::Debug for Point {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Point")
         .field("x", &self.x)
         .field("y", &self.y)
         .finish()
    }
}

let origin = Point { x: 0, y: 0 };

assert_eq!(
    format!("The origin is: {origin:?}"),
    "The origin is: Point { x: 0, y: 0 }",
);

There are a number of helper methods on the Formatter struct to help you with manual implementations, such as debug_struct.

Types that do not wish to use the standard suite of debug representations provided by the Formatter trait (debug_struct, debug_tuple, debug_list, debug_set, debug_map) can do something totally custom by manually writing an arbitrary representation to the Formatter.

impl fmt::Debug for Point {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Point [{} {}]", self.x, self.y)
    }
}

Debug implementations using either derive or the debug builder API on Formatter support pretty-printing using the alternate flag: {:#?}.

Pretty-printing with #?:

#[derive(Debug)]
struct Point {
    x: i32,
    y: i32,
}

let origin = Point { x: 0, y: 0 };

let expected = "The origin is: Point {
    x: 0,
    y: 0,
}";
assert_eq!(format!("The origin is: {origin:#?}"), expected);

Required Methods§

1.0.0

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::Debug for Position {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_tuple("")
         .field(&self.longitude)
         .field(&self.latitude)
         .finish()
    }
}

let position = Position { longitude: 1.987, latitude: 2.983 };
assert_eq!(format!("{position:?}"), "(1.987, 2.983)");

assert_eq!(format!("{position:#?}"), "(
    1.987,
    2.983,
)");

Debug

Trait Debug Copy item path

§Stability

§Examples

Required Methods§

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

§Errors

§Examples

Implementors§

impl Debug for EntityEvents

impl Debug for EventValue

impl Debug for FieldValue

impl Debug for ClassError

impl Debug for CombatLogError

impl Debug for EntityError

impl Debug for FieldValueError

impl Debug for GameEventError

impl Debug for ParserError

impl Debug for SerializerError

impl Debug for StringTableError

impl Debug for ESyncType

impl Debug for EAddGem

impl Debug for EAddSocket

impl Debug for EExtractGems

impl Debug for EResetGem

impl Debug for ResponseType

impl Debug for BidirectionalMessages

impl Debug for BidirectionalMessagesLowFrequency

impl Debug for ClcMessages

impl Debug for DialogType

impl Debug for EBaseEntityMessages

impl Debug for EBaseGameEvents

impl Debug for EBaseUserMessages

impl Debug for ECustomGameInstallStatus

impl Debug for EDemoCommands

impl Debug for EHapticPulseType

impl Debug for ENetworkDisconnectionReason

impl Debug for EProtoDebugVisiblity

impl Debug for EProtoExecutionSite

impl Debug for EQueryCvarValueStatus

impl Debug for ERollType

impl Debug for ESourceEngine

impl Debug for ESplitScreenMessageType

impl Debug for ESteamLearnCacheDataResult

impl Debug for ESteamLearnDataType

impl Debug for ESteamLearnGetAccessTokensResult

impl Debug for ESteamLearnInferenceMetadataResult

impl Debug for ESteamLearnInferenceResult

impl Debug for ESteamLearnSnapshotProjectResult

impl Debug for ESteammLearnRegisterDataSourceResult

impl Debug for EgcBaseMsg

impl Debug for EgcPlatform

impl Debug for GcConnectionStatus

impl Debug for GcProtoBufMsgSrc

impl Debug for NetMessages

impl Debug for ParticleMessage

impl Debug for PartnerAccountType

impl Debug for PrefetchType

impl Debug for ReplayEventTypeT

impl Debug for RequestPauseT

impl Debug for SignonStateT

impl Debug for SpawnGroupFlagsT

impl Debug for SvcMessages

impl Debug for SvcMessagesLowFrequency

impl Debug for VoiceDataFormatT

impl Debug for source2_demo::proto::prost::alloc::collections::TryReserveErrorKind

impl Debug for GetDisjointMutError

impl Debug for SearchStep

impl Debug for source2_demo::proto::prost::alloc::fmt::Alignment

impl Debug for DebugAsHex

impl Debug for Sign

impl Debug for AsciiChar

impl Debug for core::cmp::Ordering

impl Debug for Infallible

impl Debug for FromBytesWithNulError

impl Debug for c_void

impl Debug for Locality

impl Debug for AtomicOrdering

impl Debug for SimdAlign

impl Debug for IpAddr

Trait Debug