Struct UploadSession 

pub struct UploadSession { /* private fields */ }

Active chunked upload session state.

Keeps track of user ID, upload ID, destination path, total file size, and which chunks have been uploaded successfully.

Implementations

impl UploadSession

pub const MIN_CHUNK_SIZE: u64 = MIN_CHUNK_SIZE

Minimum chunk size recommended by Nextcloud (5 MiB).

pub const MAX_CHUNK_SIZE: u64 = MAX_CHUNK_SIZE

Maximum chunk size recommended by Nextcloud (5 GiB).

pub const DEFAULT_CHUNK_SIZE: u64 = DEFAULT_CHUNK_SIZE

Default chunk size used for uploads (10 MiB).

pub fn new( user_id: impl Into<String>, upload_id: impl Into<String>, destination_path: impl Into<String>, total_size: u64, ) -> Self

Creates a new upload session without any recorded chunks.

pub fn user_id(&self) -> &str

User ID of the upload owner.

pub fn upload_id(&self) -> &str

Unique identifier for this upload session.

pub fn destination_path(&self) -> &str

Destination WebDAV path or URI where the assembled file will be placed.

pub const fn total_size(&self) -> u64

Total size in bytes of the complete file being uploaded.

pub fn mark_chunk_uploaded(&self, chunk_index: u32)

Records that a chunk index has been uploaded successfully.

pub fn is_chunk_uploaded(&self, chunk_index: u32) -> bool

Checks whether a specific chunk index has been uploaded.

pub fn uploaded_chunks(&self) -> BTreeSet<u32>

Returns a set of all chunk indices uploaded so far.

pub fn uploaded_chunk_count(&self) -> usize

Number of chunks marked as successfully uploaded.

pub fn expected_chunk_count(&self, chunk_size: u64) -> Option<u32>

Calculates the expected total chunk count for the given chunk size.

Returns None if chunk_size is zero or if total chunk count overflows u32.

pub fn is_complete(&self, chunk_size: u64) -> bool

Whether all expected chunks for the given chunk size have been uploaded.

pub fn chunk_boundary( &self, chunk_index: u32, chunk_size: u64, ) -> Option<ChunkBoundary>

Calculates the byte boundary for a single 1-based chunk index.

Returns None if chunk_size is zero, chunk_index is zero, or exceeds total chunk count.

pub fn chunk_boundaries(&self, chunk_size: u64) -> Option<Vec<ChunkBoundary>>

Calculates all chunk boundaries for this upload given a chunk size.

Returns None if chunk_size is zero or if total chunk count overflows u32.

Trait Implementations

impl Clone for UploadSession

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UploadSession

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

Formats the value using the given formatter.