Struct PoolInfoResponse 

pub struct PoolInfoResponse {
    pub baker: Option<BakerId>,
    pub address: Option<AccountAddress>,
    pub equity_capital: Option<Amount>,
    pub delegated_capital: Option<Amount>,
    pub delegated_capital_cap: Option<Amount>,
    pub pool_info: Option<BakerPoolInfo>,
    pub equity_pending_change: Option<PoolPendingChange>,
    pub current_payday_info: Option<PoolCurrentPaydayInfo>,
    pub all_pool_total_capital: Option<Amount>,
    pub is_suspended: Option<bool>,
}

Type for the response of GetPoolInfo. Contains information about a given pool at the end of a given block. From protocol version 7, pool removal has immediate effect, however, the pool may still be present for the current (and possibly next) reward period. In this case, the current_payday_info field will be set, but the equity_capital, delegated_capital, delegated_capital_cap and, pool_info fields will all be absent. The equity_pending_change field will also be absent, as stake changes are immediate.

Fields

baker: Option<BakerId>

The ‘BakerId’ of the pool owner.

address: Option<AccountAddress>

The account address of the pool owner.

equity_capital: Option<Amount>

The equity capital provided by the pool owner. Absent if the pool is removed.

delegated_capital: Option<Amount>

The capital delegated to the pool by other accounts. Absent if the pool is removed.

delegated_capital_cap: Option<Amount>

The maximum amount that may be delegated to the pool, accounting for leverage and stake limits. Absent if the pool is removed.

pool_info: Option<BakerPoolInfo>

The pool info associated with the pool: open status, metadata URL and commission rates. Absent if the pool is removed.

equity_pending_change: Option<PoolPendingChange>

Any pending change to the equity capital. This is not used from protocol version 7 onwards, as stake changes are immediate.

current_payday_info: Option<PoolCurrentPaydayInfo>

Information of the pool in the current reward period.

all_pool_total_capital: Option<Amount>

Total capital staked across all pools, including passive delegation.

is_suspended: Option<bool>

A flag indicating whether the pool owner is suspended. Absent if the protocol version does not support validator suspension or the pool is removed.

Implementations

impl PoolInfoResponse

pub fn is_suspended(&self) -> bool

Returns the value of is_suspended, or the default value if is_suspended is unset.

Trait Implementations

impl Clone for PoolInfoResponse

fn clone(&self) -> PoolInfoResponse

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PoolInfoResponse

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

Formats the value using the given formatter.

impl Default for PoolInfoResponse

fn default() -> Self

Returns the “default value” for a type.

impl Message for PoolInfoResponse

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for PoolInfoResponse

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<PoolInfoResponse> for BakerPoolStatus

type Error = Status

The type returned in the event of a conversion error.

fn try_from(value: PoolInfoResponse) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for PoolInfoResponse