reth_downloaders/
lib.rs

1//! Implements the downloader algorithms.
2//!
3//! ## Feature Flags
4//!
5//! - `test-utils`: Export utilities for testing
6
7#![doc(
8    html_logo_url = "https://raw.githubusercontent.com/paradigmxyz/reth/main/assets/reth-docs.png",
9    html_favicon_url = "https://avatars0.githubusercontent.com/u/97369466?s=256",
10    issue_tracker_base_url = "https://github.com/paradigmxyz/reth/issues/"
11)]
12#![cfg_attr(not(test), warn(unused_crate_dependencies))]
13#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
14
15/// The collection of algorithms for downloading block bodies.
16pub mod bodies;
17
18/// The collection of algorithms for downloading block headers.
19pub mod headers;
20
21/// Common downloader metrics.
22pub mod metrics;
23
24/// Module managing file-based data retrieval and buffering.
25///
26/// Contains [`FileClient`](file_client::FileClient) to read block data from files,
27/// efficiently buffering headers and bodies for retrieval.
28pub mod file_client;
29
30/// Module managing file-based data retrieval and buffering of receipts.
31///
32/// Contains [`ReceiptFileClient`](receipt_file_client::ReceiptFileClient) to read receipt data from
33/// files, efficiently buffering receipts for retrieval.
34pub mod receipt_file_client;
35
36/// Module with a codec for reading and encoding block bodies in files.
37///
38/// Enables decoding and encoding `Block` types within file contexts.
39pub mod file_codec;
40
41#[cfg(any(test, feature = "test-utils"))]
42pub mod test_utils;
43
44pub use file_client::{DecodedFileChunk, FileClientError};