Struct BlobDownloadStream 

pub struct BlobDownloadStream { /* private fields */ }

A blob body being downloaded, returned by JmapClient::download_blob_stream.

Yields the blob as Bytes chunks in arrival order and ends after the first Err. The ClientConfig::max_download_body cap is enforced on the running total: the chunk that would cross it is not yielded, and ClientError::ResponseTooLarge is yielded instead.

When the download was started with expected_sha256, the digest is checked after the last chunk, and a mismatch is yielded as a final ClientError::BlobIntegrityMismatch. Chunks yielded before that point are therefore unverified: treat the blob as intact only once the stream has ended without an error.

Implementations

impl BlobDownloadStream

pub fn content_length(&self) -> Option<u64>

The Content-Length the server advertised, if any — for example, to size a progress bar. It is already known to be within the download cap; the byte count the stream actually yields is what the cap and the digest check apply to.

Trait Implementations

impl Debug for BlobDownloadStream

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

Formats the value using the given formatter.

impl Stream for BlobDownloadStream

type Item = Result<Bytes, ClientError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.