Struct BlocksQuery

#[non_exhaustive]
pub struct BlocksQuery {
    pub count: usize,
    pub latest: Option<Height>,
    pub earliest: Option<Height>,
    pub skip_empty_blocks: bool,
    pub add_blocks_time: bool,
    pub add_precommits: bool,
}

Blocks in range parameters.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

count: usize

The number of blocks to return. Should not be greater than MAX_BLOCKS_PER_REQUEST.

latest: Option<Height>

The maximum height of the returned blocks.

The blocks are returned in reverse order, starting from the latest and at least up to the latest - count + 1. The default value is the height of the latest block in the blockchain.

earliest: Option<Height>

The minimum height of the returned blocks. The default value is Height(0) (the genesis block).

Note that earliest has the least priority compared to latest and count; it can only truncate the list of otherwise returned blocks if some of them have a lesser height.

skip_empty_blocks: bool

If true, then only non-empty blocks are returned. The default value is false.

add_blocks_time: bool

If true, then the time field in each returned block will contain the median time from the block precommits.

add_precommits: bool

If true, then the precommits field in each returned block will contain precommits for the block stored by the node.

Trait Implementations

impl Clone for BlocksQuery

fn clone(&self) -> BlocksQuery

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlocksQuery

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

Formats the value using the given formatter.

impl Default for BlocksQuery

fn default() -> BlocksQuery

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BlocksQuery

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BlocksQuery

fn eq(&self, other: &BlocksQuery) -> 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 Serialize for BlocksQuery

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BlocksQuery