Enum polkadot_node_subsystem_types::messages::ChainApiMessage[][src]

pub enum ChainApiMessage {
    BlockNumber(HashChainApiResponseChannel<Option<BlockNumber>>),
    BlockHeader(HashChainApiResponseChannel<Option<BlockHeader>>),
    BlockWeight(HashChainApiResponseChannel<Option<BlockWeight>>),
    FinalizedBlockHash(BlockNumberChainApiResponseChannel<Option<Hash>>),
    FinalizedBlockNumber(ChainApiResponseChannel<BlockNumber>),
    Ancestors {
        hash: Hash,
        k: usize,
        response_channel: ChainApiResponseChannel<Vec<Hash>>,
    },
}
Expand description

Chain API request subsystem message.

Variants

BlockNumber(HashChainApiResponseChannel<Option<BlockNumber>>)

Request the block number by hash. Returns None if a block with the given hash is not present in the db.

Tuple Fields of BlockNumber

0: Hash1: ChainApiResponseChannel<Option<BlockNumber>>
BlockHeader(HashChainApiResponseChannel<Option<BlockHeader>>)

Request the block header by hash. Returns None if a block with the given hash is not present in the db.

Tuple Fields of BlockHeader

0: Hash1: ChainApiResponseChannel<Option<BlockHeader>>
BlockWeight(HashChainApiResponseChannel<Option<BlockWeight>>)

Get the cumulative weight of the given block, by hash. If the block or weight is unknown, this returns None.

Note: this is the weight within the low-level fork-choice rule, not the high-level one implemented in the chain-selection subsystem.

Weight is used for comparing blocks in a fork-choice rule.

Tuple Fields of BlockWeight

0: Hash1: ChainApiResponseChannel<Option<BlockWeight>>
FinalizedBlockHash(BlockNumberChainApiResponseChannel<Option<Hash>>)

Request the finalized block hash by number. Returns None if a block with the given number is not present in the db. Note: the caller must ensure the block is finalized.

Tuple Fields of FinalizedBlockHash

0: BlockNumber1: ChainApiResponseChannel<Option<Hash>>
FinalizedBlockNumber(ChainApiResponseChannel<BlockNumber>)

Request the last finalized block number. This request always succeeds.

Tuple Fields of FinalizedBlockNumber

0: ChainApiResponseChannel<BlockNumber>
Ancestors

Request the k ancestors block hashes of a block with the given hash. The response channel may return a Vec of size up to k filled with ancestors hashes with the following order: parent, grandparent, …

Fields of Ancestors

hash: Hash

The hash of the block in question.

k: usize

The number of ancestors to request.

response_channel: ChainApiResponseChannel<Vec<Hash>>

The response channel.

Implementations

If the current variant contains the relay parent hash, return it.

Trait Implementations

Formats the value using the given formatter. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Convert from a value of T into an equivalent instance of Option<Self>. Read more

Consume self to return Some equivalent value of Option<T>. Read more

Converts self into T using Into<T>. Read more

Converts self into a target type. Read more

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

Causes self to use its Binary implementation when Debug-formatted.

Causes self to use its Display implementation when Debug-formatted. Read more

Causes self to use its LowerExp implementation when Debug-formatted. Read more

Causes self to use its LowerHex implementation when Debug-formatted. Read more

Causes self to use its Octal implementation when Debug-formatted.

Causes self to use its Pointer implementation when Debug-formatted. Read more

Causes self to use its UpperExp implementation when Debug-formatted. Read more

Causes self to use its UpperHex implementation when Debug-formatted. Read more

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

Cast reference.

Cast reference.

Cast mutable reference.

Cast mutable reference.

Get a reference to the inner from the outer.

Get a mutable reference to the inner from the outer.

Pipes by value. This is generally the method you want to use. Read more

Borrows self and passes that borrow into the pipe function. Read more

Mutably borrows self and passes that borrow into the pipe function. Read more

Borrows self, then passes self.borrow() into the pipe function. Read more

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

Borrows self, then passes self.as_ref() into the pipe function.

Mutably borrows self, then passes self.as_mut() into the pipe function. Read more

Borrows self, then passes self.deref() into the pipe function.

Mutably borrows self, then passes self.deref_mut() into the pipe function. Read more

Pipes a value into a function that cannot ordinarily be called in suffix position. Read more

Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more

Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more

Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more

Pipes a trait mutable borrow into a function that cannot normally be called in suffix position. Read more

Pipes a dereference into a function that cannot normally be called in suffix position. Read more

Pipes a mutable dereference into a function that cannot normally be called in suffix position. Read more

Pipes a reference into a function that cannot ordinarily be called in suffix position. Read more

Pipes a mutable reference into a function that cannot ordinarily be called in suffix position. Read more

The alignment of pointer.

The type for initializers.

Initializes a with the given initializer. Read more

Dereferences the given pointer. Read more

Mutably dereferences the given pointer. Read more

Drops the object pointed to by the given pointer. Read more

Should always be Self

Convert from a value of T into an equivalent instance of Self. Read more

Consume self to return an equivalent value of T. Read more

Immutable access to a value. Read more

Mutable access to a value. Read more

Immutable access to the Borrow<B> of a value. Read more

Mutable access to the BorrowMut<B> of a value. Read more

Immutable access to the AsRef<R> view of a value. Read more

Mutable access to the AsMut<R> view of a value. Read more

Immutable access to the Deref::Target of a value. Read more

Mutable access to the Deref::Target of a value. Read more

Calls .tap() only in debug builds, and is erased in release builds.

Calls .tap_mut() only in debug builds, and is erased in release builds. Read more

Calls .tap_borrow() only in debug builds, and is erased in release builds. Read more

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds. Read more

Calls .tap_ref() only in debug builds, and is erased in release builds. Read more

Calls .tap_ref_mut() only in debug builds, and is erased in release builds. Read more

Calls .tap_deref() only in debug builds, and is erased in release builds. Read more

Calls .tap_deref_mut() only in debug builds, and is erased in release builds. Read more

Provides immutable access for inspection. Read more

Calls tap in debug builds, and does nothing in release builds.

Provides mutable access for modification. Read more

Calls tap_mut in debug builds, and does nothing in release builds.

Provides immutable access to the reference for inspection.

Calls tap_ref in debug builds, and does nothing in release builds.

Provides mutable access to the reference for modification.

Calls tap_ref_mut in debug builds, and does nothing in release builds.

Provides immutable access to the borrow for inspection. Read more

Calls tap_borrow in debug builds, and does nothing in release builds.

Provides mutable access to the borrow for modification.

Calls tap_borrow_mut in debug builds, and does nothing in release builds. Read more

Immutably dereferences self for inspection.

Calls tap_deref in debug builds, and does nothing in release builds.

Mutably dereferences self for modification.

Calls tap_deref_mut in debug builds, and does nothing in release builds. Read more

Attempts to convert self into T using TryInto<T>. Read more

Attempts to convert self into a target type. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The counterpart to unchecked_from.

Consume self to return an equivalent value of T.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more