Struct databento::historical::batch::DownloadParams

pub struct DownloadParams {
    pub output_dir: PathBuf,
    pub job_id: String,
    pub filename_to_download: Option<String>,
}

Available on crate feature historical only.

The parameters for BatchClient::download(). Use DownloadParams::builder() to get a builder type with all the preset defaults.

Fields

output_dir: PathBuf

The directory to download the file(s) to.

job_id: String

The batch job identifier.

filename_to_download: Option<String>

None means all files associated with the job will be downloaded.

Implementations

impl DownloadParams

pub fn builder() -> DownloadParamsBuilder<((), (), ())>

Create a builder for building DownloadParams. On the builder, call .output_dir(...), .job_id(...), .filename_to_download(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of DownloadParams.

Trait Implementations

impl Clone for DownloadParams

fn clone(&self) -> DownloadParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DownloadParams

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

Formats the value using the given formatter.

impl PartialEq for DownloadParams

fn eq(&self, other: &DownloadParams) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for DownloadParams

impl StructuralPartialEq for DownloadParams