Trait HeadersClient

pub trait HeadersClient: DownloadClient {
    type Header: Send + Sync + Unpin;
    type Output: Future<Output = PeerRequestResult<Vec<Self::Header>>> + Sync + Send + Unpin;

    // Required method
    fn get_headers_with_priority(
        &self,
        request: HeadersRequest,
        priority: Priority,
    ) -> Self::Output;

    // Provided methods
    fn get_headers(&self, request: HeadersRequest) -> Self::Output { ... }
    fn get_header(
        &self,
        start: BlockHashOrNumber,
    ) -> SingleHeaderRequest<Self::Output>  { ... }
    fn get_header_with_priority(
        &self,
        start: BlockHashOrNumber,
        priority: Priority,
    ) -> SingleHeaderRequest<Self::Output>  { ... }
}

The block headers downloader client

Required Associated Types

type Header: Send + Sync + Unpin

The header type this client fetches.

type Output: Future<Output = PeerRequestResult<Vec<Self::Header>>> + Sync + Send + Unpin

The headers future type

Required Methods

fn get_headers_with_priority( &self, request: HeadersRequest, priority: Priority, ) -> Self::Output

Sends the header request to the p2p network with priority set and returns the header response received from a peer.

Provided Methods

fn get_headers(&self, request: HeadersRequest) -> Self::Output

Sends the header request to the p2p network and returns the header response received from a peer.

fn get_header( &self, start: BlockHashOrNumber, ) -> SingleHeaderRequest<Self::Output>

Fetches a single header for the requested number or hash.

fn get_header_with_priority( &self, start: BlockHashOrNumber, priority: Priority, ) -> SingleHeaderRequest<Self::Output>

Fetches a single header for the requested number or hash with priority

Implementations on Foreign Types

impl<'a, T: 'a + HeadersClient + ?Sized> HeadersClient for &'a T

where &'a T: DownloadClient,

type Header = <T as HeadersClient>::Header

type Output = <T as HeadersClient>::Output

fn get_headers(&self, request: HeadersRequest) -> Self::Output

fn get_headers_with_priority( &self, request: HeadersRequest, priority: Priority, ) -> Self::Output

fn get_header( &self, start: BlockHashOrNumber, ) -> SingleHeaderRequest<Self::Output>

fn get_header_with_priority( &self, start: BlockHashOrNumber, priority: Priority, ) -> SingleHeaderRequest<Self::Output>

impl<T: HeadersClient + ?Sized> HeadersClient for Box<T>

where Box<T>: DownloadClient,

type Header = <T as HeadersClient>::Header

type Output = <T as HeadersClient>::Output

fn get_headers(&self, request: HeadersRequest) -> Self::Output

fn get_headers_with_priority( &self, request: HeadersRequest, priority: Priority, ) -> Self::Output

fn get_header( &self, start: BlockHashOrNumber, ) -> SingleHeaderRequest<Self::Output>

fn get_header_with_priority( &self, start: BlockHashOrNumber, priority: Priority, ) -> SingleHeaderRequest<Self::Output>

impl<T: HeadersClient + ?Sized> HeadersClient for Arc<T>

where Arc<T>: DownloadClient,

type Header = <T as HeadersClient>::Header

type Output = <T as HeadersClient>::Output

fn get_headers(&self, request: HeadersRequest) -> Self::Output

fn get_headers_with_priority( &self, request: HeadersRequest, priority: Priority, ) -> Self::Output

fn get_header( &self, start: BlockHashOrNumber, ) -> SingleHeaderRequest<Self::Output>

fn get_header_with_priority( &self, start: BlockHashOrNumber, priority: Priority, ) -> SingleHeaderRequest<Self::Output>

Implementors

impl HeadersClient for NoopFullBlockClient

Available on crate feature test-utils only.

type Header = Header

type Output = Ready<Result<WithPeerId<Vec<Header>>, RequestError>>

impl HeadersClient for TestFullBlockClient

Available on crate feature test-utils only.

Implements the HeadersClient trait for the TestFullBlockClient struct.

type Header = Header

type Output = Ready<Result<WithPeerId<Vec<Header>>, RequestError>>

impl HeadersClient for TestHeadersClient

Available on crate feature test-utils only.

type Header = Header

type Output = Pin<Box<dyn Future<Output = Result<WithPeerId<Vec<Header>>, RequestError>> + Send + Sync>>

impl<A, B> HeadersClient for Either<A, B>

where A: HeadersClient, B: HeadersClient<Header = A::Header>,

type Header = <A as HeadersClient>::Header

type Output = Either<<A as HeadersClient>::Output, <B as HeadersClient>::Output>