namada_node::tendermint::consensus::state::fmt

Trait Debug

1.0.0 · Source

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 · 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::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 &dyn TargetIsa

impl Debug for namada_node::ethereum_oracle::control::Command

impl Debug for namada_node::ethereum_oracle::Error

impl Debug for namada_node::ethereum_oracle::events::eth_events::Error

impl Debug for namada_node::protocol::Error

impl Debug for GasMeterKind

impl Debug for AllocFailure

impl Debug for namada_node::shell::Error

impl Debug for MempoolTxType

impl Debug for ResultCode

impl Debug for namada_node::shims::abcipp_shim_types::shim::Error

impl Debug for namada_node::shims::abcipp_shim_types::shim::Response

impl Debug for TakeSnapshot

impl Debug for namada_node::tendermint_node::Error

impl Debug for namada_node::tendermint_proto::abci::CheckTxType

impl Debug for namada_node::tendermint_proto::abci::MisbehaviorType

impl Debug for namada_node::tendermint_proto::abci::request::Value

impl Debug for namada_node::tendermint_proto::abci::response::Value

impl Debug for namada_node::tendermint_proto::abci::response_apply_snapshot_chunk::Result

impl Debug for namada_node::tendermint_proto::abci::response_offer_snapshot::Result

impl Debug for namada_node::tendermint_proto::abci::response_process_proposal::ProposalStatus

impl Debug for namada_node::tendermint_proto::blocksync::message::Sum

impl Debug for namada_node::tendermint_proto::consensus::message::Sum

impl Debug for namada_node::tendermint_proto::consensus::wal_message::Sum

impl Debug for namada_node::tendermint_proto::crypto::public_key::Sum

impl Debug for namada_node::tendermint_proto::mempool::message::Sum

impl Debug for namada_node::tendermint_proto::p2p::message::Sum

impl Debug for namada_node::tendermint_proto::p2p::packet::Sum

impl Debug for namada_node::tendermint_proto::privval::Errors

impl Debug for namada_node::tendermint_proto::privval::message::Sum

impl Debug for namada_node::tendermint_proto::statesync::message::Sum

impl Debug for namada_node::tendermint_proto::types::BlockIdFlag

impl Debug for namada_node::tendermint_proto::types::SignedMsgType

impl Debug for namada_node::tendermint_proto::types::evidence::Sum

impl Debug for ApplySnapshotChunkResult

impl Debug for namada_node::tendermint::abci::Code

impl Debug for namada_node::tendermint::abci::ConsensusRequest

impl Debug for namada_node::tendermint::abci::ConsensusResponse

impl Debug for namada_node::tendermint::abci::EventAttribute

impl Debug for namada_node::tendermint::abci::InfoRequest

impl Debug for namada_node::tendermint::abci::InfoResponse

impl Debug for namada_node::tendermint::abci::MempoolRequest

impl Debug for namada_node::tendermint::abci::MempoolResponse

impl Debug for namada_node::tendermint::abci::Request

impl Debug for namada_node::tendermint::abci::Response

impl Debug for namada_node::tendermint::abci::SnapshotRequest

impl Debug for namada_node::tendermint::abci::SnapshotResponse

impl Debug for CheckTxKind

impl Debug for namada_node::tendermint::abci::response::OfferSnapshot

impl Debug for namada_node::tendermint::abci::response::ProcessProposal

impl Debug for BlockSignatureInfo

impl Debug for MisbehaviorKind

impl Debug for namada_node::tendermint::block::BlockIdFlag

impl Debug for namada_node::tendermint::block::CommitSig

impl Debug for namada_node::tendermint::crypto::signature::Error

impl Debug for namada_node::tendermint::Hash

impl Debug for namada_node::tendermint::PublicKey

impl Debug for TendermintKey

impl Debug for namada_node::tendermint::error::ErrorDetail

impl Debug for namada_node::tendermint::evidence::Evidence

impl Debug for namada_node::tendermint::hash::Algorithm

impl Debug for TxIndexStatus

impl Debug for namada_node::tendermint::proposal::Type

impl Debug for namada_node::tendermint::public_key::Algorithm

impl Debug for namada_node::tendermint::v0_34::abci::ConsensusRequest

impl Debug for namada_node::tendermint::v0_34::abci::ConsensusResponse

impl Debug for namada_node::tendermint::v0_34::abci::InfoRequest

impl Debug for namada_node::tendermint::v0_34::abci::InfoResponse

impl Debug for namada_node::tendermint::v0_34::abci::MempoolRequest

impl Debug for namada_node::tendermint::v0_34::abci::MempoolResponse

impl Debug for namada_node::tendermint::v0_34::abci::Request

Trait Debug