Struct FileClient

pub struct FileClient<B: Block = Block> { /* private fields */ }

Front-end API for fetching chain data from a file.

Blocks are assumed to be written one after another in a file, as rlp bytes.

For example, if the file contains 3 blocks, the file is assumed to be encoded as follows: rlp(block1) || rlp(block2) || rlp(block3)

Blocks are assumed to have populated transactions, so reading headers will also buffer transactions in memory for use in the bodies stage.

This reads the entire file into memory, so it is not suitable for large files.

Implementations

impl<B: FullBlock> FileClient<B>

pub async fn new<P: AsRef<Path>>(path: P) -> Result<Self, FileClientError>

Create a new file client from a file path.

pub fn tip(&self) -> Option<B256>

Get the tip hash of the chain.

pub fn start(&self) -> Option<B256>

Get the start hash of the chain.

pub fn max_block(&self) -> Option<u64>

Returns the highest block number of this client has or None if empty

pub fn min_block(&self) -> Option<u64>

Returns the lowest block number of this client has or None if empty

pub fn tip_header(&self) -> Option<SealedHeader<B::Header>>

Clones and returns the highest header of this client has or None if empty. Seals header before returning.

pub fn has_canonical_blocks(&self) -> bool

Returns true if all blocks are canonical (no gaps)

pub fn with_bodies(self, bodies: HashMap<BlockHash, B::Body>) -> Self

Use the provided bodies as the file client’s block body buffer.

pub fn with_headers(self, headers: HashMap<BlockNumber, B::Header>) -> Self

Use the provided headers as the file client’s block body buffer.

pub fn headers_len(&self) -> usize

Returns the current number of headers in the client.

pub fn bodies_len(&self) -> usize

Returns the current number of bodies in the client.

pub fn headers_iter(&self) -> impl Iterator<Item = &B::Header>

Returns an iterator over headers in the client.

pub fn bodies_iter_mut(&mut self) -> impl Iterator<Item = (u64, &mut B::Body)>

Returns a mutable iterator over bodies in the client.

Panics, if file client headers and bodies are not mapping 1-1.

pub fn total_transactions(&self) -> usize

Returns the current number of transactions in the client.

Trait Implementations

impl<B: FullBlock> BodiesClient for FileClient<B>

type Body = <B as Block>::Body

The body type this client fetches.

type Output = Pin<Box<dyn Future<Output = Result<WithPeerId<Vec<<B as Block>::Body>>, RequestError>> + Send + Sync>>

The output of the request future for querying block bodies.

fn get_block_bodies_with_priority( &self, hashes: Vec<B256>, _priority: Priority, ) -> Self::Output

Fetches the block body for the requested block with priority

fn get_block_bodies(&self, hashes: Vec<FixedBytes<32>>) -> Self::Output

Fetches the block body for the requested block.

fn get_block_body( &self, hash: FixedBytes<32>, ) -> SingleBodyRequest<Self::Output>

Fetches a single block body for the requested hash.

fn get_block_body_with_priority( &self, hash: FixedBytes<32>, priority: Priority, ) -> SingleBodyRequest<Self::Output>

Fetches a single block body for the requested hash with priority

impl<B: Debug + Block> Debug for FileClient<B>

where B::Header: Debug, B::Body: Debug,

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

Formats the value using the given formatter.

impl<B: FullBlock> DownloadClient for FileClient<B>

fn report_bad_message(&self, _peer_id: PeerId)

Penalize the peer for responding with a message that violates validation rules

fn num_connected_peers(&self) -> usize

Returns how many peers the network is currently connected to.

impl<B: FullBlock> FromReader for FileClient<B>

fn from_reader<R>( reader: R, num_bytes: u64, ) -> impl Future<Output = Result<DecodedFileChunk<Self>, Self::Error>>

where R: AsyncReadExt + Unpin,

Initialize the FileClient from bytes that have been read from file.

type Error = FileClientError

Error returned by file client type.

impl<B: FullBlock> HeadersClient for FileClient<B>

type Header = <B as Block>::Header

The header type this client fetches.

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

The headers future type

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.

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: HashOrNumber) -> SingleHeaderRequest<Self::Output>

Fetches a single header for the requested number or hash.

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

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

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 144 bytes