Struct ic_agent::agent::status::Status

pub struct Status {
    pub ic_api_version: String,
    pub impl_source: Option<String>,
    pub impl_version: Option<String>,
    pub impl_revision: Option<String>,
    pub root_key: Option<Vec<u8>>,
    pub values: BTreeMap<String, Box<Value>>,
}

The structure returned by [ic_agent::Agent::status], containing the information returned by the status endpoint of a replica.

Fields

ic_api_version: String

Identifies the interface version supported, i.e. the version of the present document that the internet computer aims to support, e.g. 0.8.1. The implementation may also return unversioned to indicate that it does not comply to a particular version, e.g. in between releases.

impl_source: Option<String>

Optional. Identifies the implementation of the Internet Computer, by convention with the canonical location of the source code.

impl_version: Option<String>

Optional. If the user is talking to a released version of an Internet Computer implementation, this is the version number. For non-released versions, output of git describe like 0.1.13-13-g2414721 would also be very suitable.

impl_revision: Option<String>

Optional. The precise git revision of the Internet Computer implementation.

root_key: Option<Vec<u8>>

Optional. The root (public) key used to verify certificates.

values: BTreeMap<String, Box<Value>>

Contains any additional values that the replica gave as status.

Trait Implementations

impl Debug for Status

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

Formats the value using the given formatter.

impl Display for Status

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

Formats the value using the given formatter.

impl Eq for Status

impl Ord for Status

fn cmp(&self, other: &Status) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Status> for Status

fn eq(&self, other: &Status) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Status) -> bool

This method tests for !=.

impl PartialOrd<Status> for Status

fn partial_cmp(&self, other: &Status) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Status

impl StructuralPartialEq for Status

impl TryFrom<&'_ Value> for Status

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, ()>

Performs the conversion.