Struct DownloadDefaults 

pub struct DownloadDefaults {
    pub available_snapshots: Vec<Cow<'static, str>>,
    pub default_base_url: Cow<'static, str>,
    pub default_chain_aware_base_url: Option<Cow<'static, str>>,
    pub snapshot_api_url: Cow<'static, str>,
    pub long_help: Option<String>,
    pub full_preset_includes_rocksdb_indices: bool,
}

Download configuration defaults

Global defaults can be set via DownloadDefaults::try_init.

Fields

available_snapshots: Vec<Cow<'static, str>>

List of available snapshot sources

default_base_url: Cow<'static, str>

Default base URL for snapshots

default_chain_aware_base_url: Option<Cow<'static, str>>

Default base URL for chain-aware snapshots.

When set, the chain ID is appended to form the full URL: {base_url}/{chain_id}. For example, given a base URL of https://snapshots.example.com and chain ID 1, the resulting URL would be https://snapshots.example.com/1.

Falls back to default_base_url when None.

snapshot_api_url: Cow<'static, str>

URL for the snapshot discovery API that lists available snapshots.

Defaults to https://snapshots.reth.rs/api/snapshots.

long_help: Option<String>

Optional custom long help text that overrides the generated help

full_preset_includes_rocksdb_indices: bool

Whether the full preset also downloads the snapshot’s RocksDB indices instead of rebuilding them.

Implementations

impl DownloadDefaults

pub fn try_init(self) -> Result<(), Self>

Initialize the global download defaults with this configuration

pub fn get_global() -> &'static DownloadDefaults

Get a reference to the global download defaults

pub fn default_download_defaults() -> Self

Default download configuration with defaults from snapshots.reth.rs and publicnode

pub fn long_help(&self) -> String

Generates the long help text for the download URL argument using these defaults.

If a custom long_help is set, it will be returned. Otherwise, help text is generated from the available_snapshots list.

pub fn with_snapshot(self, source: impl Into<Cow<'static, str>>) -> Self

Add a snapshot source to the list

pub fn with_snapshots(self, sources: Vec<Cow<'static, str>>) -> Self

Replace all snapshot sources

pub fn with_base_url(self, url: impl Into<Cow<'static, str>>) -> Self

Set the default base URL, e.g. https://downloads.merkle.io.

pub fn with_chain_aware_base_url( self, url: impl Into<Cow<'static, str>>, ) -> Self

Set the default chain-aware base URL.

pub fn with_snapshot_api_url(self, url: impl Into<Cow<'static, str>>) -> Self

Set the snapshot discovery API URL.

Generated help uses the API root as the default snapshot source unless a custom chain-aware base URL or source list was already provided.

pub fn with_snapshot_source_url(self, url: impl Into<Cow<'static, str>>) -> Self

Set one default snapshot source URL for discovery and generated CLI references.

The provided URL is the public snapshot root, such as https://snapshots.example.com. The discovery API is derived as {url}/api/snapshots.

pub const fn with_full_preset_rocksdb_indices(self) -> Self

Builder: Make the full preset also download the snapshot’s RocksDB indices.

pub fn with_long_help(self, help: impl Into<String>) -> Self

Builder: Set custom long help text, overriding the generated help

Trait Implementations

impl Clone for DownloadDefaults

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DownloadDefaults

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

Formats the value using the given formatter.

impl Default for DownloadDefaults

fn default() -> Self

Returns the built-in download defaults.

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: 128 bytes