Struct ProgressiveDownload

pub struct ProgressiveDownload<W: Write> { /* private fields */ }

A persistent single download that can be used to track progress

Implementations

impl<W: Write> ProgressiveDownload<W>

pub fn from_response(response: Response, writer: W) -> Self

Create a new ProgressiveDownload from a response

pub fn get_downloaded(&self) -> usize

Get the number of bytes that have been downloaded

pub fn get_total_length(&self) -> usize

Get the total length of the content

pub fn get_progress(&self) -> MessageContents

Get the progress message corresponding to this download

pub async fn poll_download(&mut self) -> Result<()>

Poll the download

pub fn is_finished(&self) -> bool

Check if the download is finished

impl ProgressiveDownload<BufWriter<File>>

pub async fn file( url: impl IntoUrl, path: impl AsRef<Path>, client: &Client, ) -> Result<Self>

Create a new ProgressiveDownload that downloads a file

impl ProgressiveDownload<Cursor<Vec<u8>>>

pub async fn bytes(url: impl IntoUrl, client: &Client) -> Result<Self>

Create a new ProgressiveDownload that downloads bytes

pub fn finish(self) -> Vec<u8>

Consume the download and get the resulting bytes

pub fn finish_json<D: DeserializeOwned>(self) -> Result<D>

Consume the download into JSON