Struct pcli::command::debug::DebugInfo

pub struct DebugInfo {
    cometbft_version: Option<String>,
    tendermint_version: Option<String>,
    pd_version: Option<String>,
    pcli_version: String,
    uname: Option<String>,
    pcli_data_directory: Option<PathBuf>,
    pcli_config_file: Option<PathBuf>,
}

Represents a fact sheet about system status, bottling up common support-related questions like “What chain are you on?” or “What version of Tendermint are you running?”. Intended to display output via pcli debug info, for ease of pasting into chat or issues.

Fields

cometbft_version: Option<String>

CometBFT version, if cometbft is found on PATH.

tendermint_version: Option<String>

Tendermint version, if tendermint is found on PATH.

pd_version: Option<String>

pd version, if pd is found on PATH.

pcli_version: String

pcli version; baked in at compile time, so will always be present.

uname: Option<String>

Platform and architecture info for current host.

pcli_data_directory: Option<PathBuf>

Status of directory for storing view info locally.

pcli_config_file: Option<PathBuf>

Status of pcli config TOML, containing key material for pcli.

Implementations

impl DebugInfo

pub fn new(data_dir: PathBuf) -> Self

fn get_tendermint_version() -> Option<String>

Attempt to retrieve version info for Tendermint by running tendermint version. Depending on deployment, tendermint may not be on the PATH; it may be in container context that pcli doesn’t have access to. That’s OK: we’ll just report None in that case.

fn get_cometbft_version() -> Option<String>

Attempt to retrieve version info for CometBFT by running cometbft version. Depending on deployment, cometbft may not be on the PATH; it may be in container context that pcli doesn’t have access to. That’s OK: we’ll just report None in that case.

fn get_uname() -> Option<String>

Return host info, including kernel and architecture. Should work equally well on Linux or macOS; Windows will return None.

fn get_pcli_version() -> String

Return the version for pcli baked in at compile time.

fn get_pd_version() -> Option<String>

Attempt to find pd on PATH, and return its version number. Depending on deployment, pd may not be on the path; it may in a container context elsewhere.

fn get_pcli_data_directory(data_dir: PathBuf) -> Option<PathBuf>

Check whether data dir, as provided by arg-parsing, exists.

fn get_pcli_config_file(data_dir: Option<PathBuf>) -> Option<PathBuf>

Check pcli config TOML file exists.

Trait Implementations

impl Debug for DebugInfo

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

Formats the value using the given formatter.

impl Serialize for DebugInfo

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.