SnapshotDownloader

Struct SnapshotDownloader 

Source
pub struct SnapshotDownloader { /* private fields */ }
Expand description

Downloads snapshot archives from HTTP/HTTPS and file:// URLs.

Provides secure, reliable downloading with automatic retry logic for network sources and direct file copying for local sources.

§Features

  • HTTP/HTTPS: Automatic retry with exponential backoff, progress tracking
  • Local Files: Direct copying from file:// URLs with validation
  • Safety: Size limits, disk space checks, timeout protection
  • Monitoring: Progress reporting and detailed error messages

§Examples

use std::path::Path;

use hopr_chain_indexer::snapshot::download::SnapshotDownloader;

let downloader = SnapshotDownloader::new()?;

// Download from HTTPS
downloader
    .download_snapshot(
        "https://snapshots.hoprnet.org/logs.tar.xz",
        Path::new("/tmp/snapshot.tar.xz"),
    )
    .await?;

// Copy from local file
downloader
    .download_snapshot("file:///backups/snapshot.tar.xz", Path::new("/tmp/snapshot.tar.xz"))
    .await?;

Implementations§

Source§

impl SnapshotDownloader

Source

pub fn new() -> SnapshotResult<Self>

Creates a new snapshot downloader with default configuration

Source

pub fn with_config(config: DownloadConfig) -> SnapshotResult<Self>

Creates a new snapshot downloader with custom configuration

Source

pub async fn download_snapshot( &self, url: &str, target_path: &Path, ) -> SnapshotResult<()>

Downloads a snapshot from the given URL to the target path.

Supports HTTP/HTTPS URLs with retry logic and file:// URLs for local files.

§Arguments
  • url - Source URL (http://, https://, or file:// scheme)
  • target_path - Destination file path
§Errors

Returns SnapshotError for network failures, file system errors, or validation failures.

Source

pub async fn download_snapshot_with_retry( &self, url: &str, target_path: &Path, max_retries: u32, ) -> SnapshotResult<()>

Downloads a snapshot with configurable retry logic.

Implements exponential backoff between retry attempts for HTTP/HTTPS URLs. Local file:// URLs are handled without retry logic. Certain errors (like 4xx HTTP status codes or insufficient disk space) will not be retried.

§Arguments
  • url - The HTTP/HTTPS or file:// URL to download/copy from
  • target_path - Local path where the downloaded file will be saved
  • max_retries - Maximum number of retry attempts (ignored for file:// URLs)
§Errors

Returns SnapshotError for various failure conditions including:

  • Network errors (with retry)
  • HTTP errors (4xx without retry, 5xx with retry)
  • Insufficient disk space (without retry)
  • File size exceeding limits (without retry)
Source

pub async fn check_disk_space(&self, dir: &Path) -> SnapshotResult<()>

Checks if there’s sufficient disk space available for download and extraction.

Validates that the target directory has at least 3x the maximum download size available to account for:

  1. The downloaded archive
  2. Extracted files
  3. Safety margin for system operations
§Arguments
  • dir - Directory to check for available space
§Errors

Returns SnapshotError::InsufficientSpace if available space is below requirements

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,