Struct qiniu_download_manager::DownloadingObject

pub struct DownloadingObject { /* private fields */ }

准备下载的对象

可以在下载前设置范围参数或回调函数，以及写入数据的目标。 需要注意的是，生成该对象并不表示数据处于下载状态了， 下载将在调用 Self::to_path，Self::to_writer，DownloadingObjectReader::read 以后才正式开始。

Implementations

impl DownloadingObject

pub fn range_from(self, range_from: NonZeroU64) -> Self

设置下载范围起始位置

单位为字节，如果不调用，默认从第一个字节开始下载

pub fn range_to(self, range_to: NonZeroU64) -> Self

设置下载范围结束位置，包含该位置

例如如果要下载前 500 个字节，则调用该方法时应该传入 499

单位为字节，如果不调用，默认下载到最后一个字节

pub fn retrier(self, retrier: impl DownloadRetrier + 'static) -> Self

设置下载重试器

默认使用 ErrorRetrier

pub fn headers(self, headers: HeaderMap) -> Self

设置 HTTP 请求头

pub fn set_header( self, header_name: impl IntoHeaderName, header_value: impl Into<HeaderValue> ) -> Self

添加 HTTP 请求头

pub fn on_before_request<F>(self, callback: F) -> Self

where F: Fn(&mut RequestBuilderParts<'_>) -> AnyResult<()> + Send + Sync + 'static,

设置请求前的回调函数

pub fn on_download_progress<F: Fn(DownloadingProgressInfo) -> AnyResult<()> + Send + Sync + 'static>( self, callback: F ) -> Self

设置下载进度回调函数

pub fn on_response_ok<F: Fn(&mut HttpResponseParts) -> AnyResult<()> + Send + Sync + 'static>( self, callback: F ) -> Self

设置响应成功的回调函数

pub fn on_response_error<F: Fn(&mut ResponseError) -> AnyResult<()> + Send + Sync + 'static>( self, callback: F ) -> Self

设置响应错误的回调函数

pub fn to_path(self, path: impl AsRef<Path>) -> DownloadResult<()>

将下载的对象内容写入指定的文件系统路径

需要注意，如果文件已经存在，则会覆盖该文件，如果文件不存在，则会创建该文件。

该方法的异步版本为 Self::async_to_path。

代码示例

download_manager
    .download(object_name)?
    .to_path("/home/qiniu/test.png")?;

pub async fn async_to_path(self, path: impl AsRef<Path>) -> DownloadResult<()>

Available on crate feature async only.

将下载的对象内容异步写入指定的文件系统路径

需要注意，如果文件已经存在，则会覆盖该文件，如果文件不存在，则会创建该文件。

代码示例

download_manager
    .async_download(object_name)
    .await?
    .async_to_path("/home/qiniu/test.png")
    .await?;

pub fn to_writer(self, writer: &mut dyn Write) -> DownloadResult<()>

将下载的对象内容写入指定的输出流

该方法的异步版本为 Self::to_async_writer。

代码示例

let mut buf = Vec::new();
download_manager
    .download(object_name)?
    .to_writer(&mut buf)?;

pub async fn to_async_writer( self, writer: &mut (dyn AsyncWrite + Send + Sync + Unpin) ) -> DownloadResult<()>

Available on crate feature async only.

将下载的对象内容写入指定的异步输出流

代码示例

let mut buf = Vec::new();
download_manager
    .async_download(object_name)
    .await?
    .to_async_writer(&mut buf)
    .await?;

pub fn into_read(self) -> DownloadingObjectReader

将下载的对象内容包装成 Read 对象

但注意，由于 Read 接口的限制，错误信息会被 IoError 封装

该方法的异步版本为 Self::into_async_read。

代码示例

let mut buf = Vec::new();
let mut reader = download_manager
    .download(object_name)?
    .into_read();
std::io::copy(&mut reader, &mut buf)?;

pub fn into_async_read(self) -> AsyncDownloadingObjectReader

Available on crate feature async only.

将下载的对象内容包装成 [futures::AsyncRead] 对象

但注意，由于 [futures::AsyncRead] 接口的限制，错误信息会被 IoError 封装

代码示例

let mut buf = Vec::new();
let mut reader = download_manager
    .async_download(object_name)
    .await?
    .into_async_read();
futures::io::copy(&mut reader, &mut buf).await?;

Trait Implementations

impl Debug for DownloadingObject

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

Formats the value using the given formatter.