Skip to main content

UploadValidator

Struct UploadValidator 

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

Validates one UploadPack stream’s framing, chunk by chunk, without buffering or hashing. After any error the stream is dead: every later call returns that same error.

Implementations§

Source§

impl UploadValidator

Source

pub fn new( pack_id: Option<&[u8]>, total_bytes: Option<u64>, limits: UploadLimits, ) -> Result<Self, UploadError>

Start validating from the header’s pack_id and total_bytes (None when absent).

§Errors

UploadError::BadPackId, UploadError::TotalMissing or UploadError::TotalTooLarge.

Source

pub fn push( &mut self, chunk_pack_id: Option<&[u8]>, offset: Option<u64>, data_len: usize, last: bool, ) -> Result<Progress, UploadError>

Account for one chunk carrying data_len bytes.

§Errors

UploadError::AfterLast, UploadError::TooManyChunks, UploadError::BadPackId, UploadError::PackIdMismatch, UploadError::OffsetMissing, UploadError::OffsetGap, UploadError::ByteCountOverflow, UploadError::Overrun or, on the last chunk, UploadError::LengthMismatch. After any error, this and every later call return that same error, and nothing the failed chunk carried is counted.

Source

pub fn finish(self) -> Result<UploadDone, UploadError>

End of stream.

§Errors

The error that killed the stream, if any; otherwise UploadError::NoLast if the last chunk never arrived.

Source

pub const fn key(&self) -> PackKey

The pack id the header declared.

Source

pub const fn declared(&self) -> u64

The total_bytes the header declared.

Source

pub const fn received(&self) -> u64

Bytes accepted so far.

Trait Implementations§

Source§

impl Clone for UploadValidator

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UploadValidator

Source§

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

Formats the value using the given formatter. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> MaybeSend for T
where T: Send + ?Sized,

Source§

impl<T> MaybeSync for T
where T: Sync + ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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