UploadTask

Struct UploadTask 

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

Stateful helper that mirrors the Firebase Web SDK’s resumable upload behaviour.

A task is created via StorageReference::upload_bytes_resumable and can then be polled chunk-by-chunk (upload_next) or allowed to run to completion (run_to_completion). Small payloads are uploaded with a single multipart request, whereas larger blobs utilise the resumable REST API.

Implementations§

Source§

impl UploadTask

Source

pub fn total_bytes(&self) -> u64

Returns the total number of bytes that will be uploaded.

Source

pub fn bytes_transferred(&self) -> u64

Returns the number of bytes that have been successfully uploaded so far.

Source

pub fn state(&self) -> UploadTaskState

Current task state.

Source

pub fn last_error(&self) -> Option<&StorageError>

Last error reported by the task, if any.

Source

pub fn metadata(&self) -> Option<&ObjectMetadata>

Resulting object metadata after a successful upload.

Source

pub fn upload_session_url(&self) -> Option<&str>

The resumable session URL, if one has been established.

Source

pub fn upload_next_with_progress<F>( &mut self, progress: F, ) -> StorageResult<Option<ObjectMetadata>>

Uploads the next chunk and invokes the provided progress callback.

Returns Ok(Some(metadata)) when the upload finishes and the remote metadata is available.

Source

pub fn upload_next(&mut self) -> StorageResult<Option<ObjectMetadata>>

Uploads the next chunk without emitting progress callbacks.

Source

pub fn run_to_completion_with_progress<F>( self, progress: F, ) -> StorageResult<ObjectMetadata>

Runs the task to completion while notifying progress for each chunk.

Source

pub fn run_to_completion(self) -> StorageResult<ObjectMetadata>

Runs the task to completion without progress callbacks.

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.

Source§

impl<T> Instrument for T

Source§

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

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

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> 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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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