Struct ffsend_api::reader::ProgressReader

source ·

pub struct ProgressReader<R> { /* private fields */ }

Expand description

A reader wrapper, that measures the reading process for a reader with a known length.

If the reader exceeds the initially specified length, the reader will continue to allow reads. The length property will grow accordingly.

The reader will only start producing None if the wrapped reader is doing so.

Implementations

source

impl<R: Read> ProgressReader<R>

source

pub fn new(inner: R) -> Result<Self, IoError>where
R: ExactLengthReader,

Wrap the given reader with an exact length, in a progress reader.

source

pub fn from(inner: R, len: u64) -> Self

Wrap the given reader with the given length in a progress reader.

source

pub fn set_reporter(&mut self, reporter: Arc<Mutex<dyn ProgressReporter>>)

Set the reporter to report the status to.

source

pub fn progress(&self) -> u64

Get the current progress.

Trait Implementations

source

impl<R: Read> ExactLengthReader for ProgressReader<R>

source

fn len(&self) -> Result<u64, Error>

Get the exact length of the reader in bytes.

source

fn is_empty(&self) -> Result<bool, Error>

Check whehter this extact length reader is emtpy.

source

impl<R: Read> Read for ProgressReader<R>

source

fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>

Read from the encrypted file, and then the encryption tag.

1.36.0 · source

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers. Read more

source

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation. Read more

1.0.0 · source

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf. Read more

1.0.0 · source

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf. Read more

1.6.0 · source

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf. Read more

source

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer. Read more

source

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill cursor. Read more

1.0.0 · source

fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,

Creates a “by reference” adaptor for this instance of Read. Read more

1.0.0 · source

fn bytes(self) -> Bytes<Self>where
Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more

1.0.0 · source

fn chain<R>(self, next: R) -> Chain<Self, R>where
R: Read,
Self: Sized,

Creates an adapter which will chain this stream with another. Read more

1.0.0 · source

fn take(self, limit: u64) -> Take<Self>where
Self: Sized,

Creates an adapter which will read at most limit bytes from it. Read more

Auto Trait Implementations

impl<R> RefUnwindSafe for ProgressReader<R>where
R: RefUnwindSafe,

impl<R> Send for ProgressReader<R>where
R: Send,

impl<R> Sync for ProgressReader<R>where
R: Sync,

impl<R> Unpin for ProgressReader<R>where
R: Unpin,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<R> ReadBytesExt for Rwhere
R: Read + ?Sized,

fn read_u8(&mut self) -> Result<u8, Error>

Reads an unsigned 8 bit integer from the underlying reader. Read more

fn read_i8(&mut self) -> Result<i8, Error>

Reads a signed 8 bit integer from the underlying reader. Read more

fn read_u16<T>(&mut self) -> Result<u16, Error>where
T: ByteOrder,

Reads an unsigned 16 bit integer from the underlying reader. Read more

fn read_i16<T>(&mut self) -> Result<i16, Error>where
T: ByteOrder,

Reads a signed 16 bit integer from the underlying reader. Read more

fn read_u24<T>(&mut self) -> Result<u32, Error>where
T: ByteOrder,

Reads an unsigned 24 bit integer from the underlying reader. Read more

fn read_i24<T>(&mut self) -> Result<i32, Error>where
T: ByteOrder,

Reads a signed 24 bit integer from the underlying reader. Read more

fn read_u32<T>(&mut self) -> Result<u32, Error>where
T: ByteOrder,

Reads an unsigned 32 bit integer from the underlying reader. Read more

fn read_i32<T>(&mut self) -> Result<i32, Error>where
T: ByteOrder,

Reads a signed 32 bit integer from the underlying reader. Read more

fn read_u48<T>(&mut self) -> Result<u64, Error>where
T: ByteOrder,

Reads an unsigned 48 bit integer from the underlying reader. Read more

fn read_i48<T>(&mut self) -> Result<i64, Error>where
T: ByteOrder,

Reads a signed 48 bit integer from the underlying reader. Read more

fn read_u64<T>(&mut self) -> Result<u64, Error>where
T: ByteOrder,

Reads an unsigned 64 bit integer from the underlying reader. Read more

fn read_i64<T>(&mut self) -> Result<i64, Error>where
T: ByteOrder,

Reads a signed 64 bit integer from the underlying reader. Read more

fn read_u128<T>(&mut self) -> Result<u128, Error>where
T: ByteOrder,

Reads an unsigned 128 bit integer from the underlying reader. Read more

fn read_i128<T>(&mut self) -> Result<i128, Error>where
T: ByteOrder,

Reads a signed 128 bit integer from the underlying reader. Read more

fn read_uint<T>(&mut self, nbytes: usize) -> Result<u64, Error>where
T: ByteOrder,

Reads an unsigned n-bytes integer from the underlying reader. Read more

fn read_int<T>(&mut self, nbytes: usize) -> Result<i64, Error>where
T: ByteOrder,

Reads a signed n-bytes integer from the underlying reader. Read more

fn read_uint128<T>(&mut self, nbytes: usize) -> Result<u128, Error>where
T: ByteOrder,

Reads an unsigned n-bytes integer from the underlying reader.

fn read_int128<T>(&mut self, nbytes: usize) -> Result<i128, Error>where
T: ByteOrder,

Reads a signed n-bytes integer from the underlying reader.

fn read_f32<T>(&mut self) -> Result<f32, Error>where
T: ByteOrder,

Reads a IEEE754 single-precision (4 bytes) floating point number from the underlying reader. Read more

fn read_f64<T>(&mut self) -> Result<f64, Error>where
T: ByteOrder,

Reads a IEEE754 double-precision (8 bytes) floating point number from the underlying reader. Read more

fn read_u16_into<T>(&mut self, dst: &mut [u16]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of unsigned 16 bit integers from the underlying reader. Read more

fn read_u32_into<T>(&mut self, dst: &mut [u32]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of unsigned 32 bit integers from the underlying reader. Read more

fn read_u64_into<T>(&mut self, dst: &mut [u64]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of unsigned 64 bit integers from the underlying reader. Read more

fn read_u128_into<T>(&mut self, dst: &mut [u128]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of unsigned 128 bit integers from the underlying reader. Read more

fn read_i8_into(&mut self, dst: &mut [i8]) -> Result<(), Error>

Reads a sequence of signed 8 bit integers from the underlying reader. Read more

fn read_i16_into<T>(&mut self, dst: &mut [i16]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of signed 16 bit integers from the underlying reader. Read more

fn read_i32_into<T>(&mut self, dst: &mut [i32]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of signed 32 bit integers from the underlying reader. Read more

fn read_i64_into<T>(&mut self, dst: &mut [i64]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of signed 64 bit integers from the underlying reader. Read more

fn read_i128_into<T>(&mut self, dst: &mut [i128]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of signed 128 bit integers from the underlying reader. Read more

fn read_f32_into<T>(&mut self, dst: &mut [f32]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of IEEE754 single-precision (4 bytes) floating point numbers from the underlying reader. Read more

fn read_f32_into_unchecked<T>(&mut self, dst: &mut [f32]) -> Result<(), Error>where
T: ByteOrder,

👎Deprecated since 1.2.0: please use read_f32_into instead

DEPRECATED. Read more

fn read_f64_into<T>(&mut self, dst: &mut [f64]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of IEEE754 double-precision (8 bytes) floating point numbers from the underlying reader. Read more

fn read_f64_into_unchecked<T>(&mut self, dst: &mut [f64]) -> Result<(), Error>where
T: ByteOrder,

👎Deprecated since 1.2.0: please use read_f64_into instead

DEPRECATED. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct ffsend_api::reader::ProgressReader

Implementations

impl<R: Read> ProgressReader<R>

pub fn new(inner: R) -> Result<Self, IoError>where R: ExactLengthReader,

pub fn from(inner: R, len: u64) -> Self

pub fn set_reporter(&mut self, reporter: Arc<Mutex<dyn ProgressReporter>>)

pub fn progress(&self) -> u64

Trait Implementations

impl<R: Read> ExactLengthReader for ProgressReader<R>

fn len(&self) -> Result<u64, Error>

fn is_empty(&self) -> Result<bool, Error>

impl<R: Read> Read for ProgressReader<R>

fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

fn is_read_vectored(&self) -> bool

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

fn bytes(self) -> Bytes<Self>where Self: Sized,

fn chain<R>(self, next: R) -> Chain<Self, R>where R: Read, Self: Sized,

fn take(self, limit: u64) -> Take<Self>where Self: Sized,

Auto Trait Implementations

impl<R> RefUnwindSafe for ProgressReader<R>where R: RefUnwindSafe,

impl<R> Send for ProgressReader<R>where R: Send,

impl<R> Sync for ProgressReader<R>where R: Sync,

impl<R> Unpin for ProgressReader<R>where R: Unpin,

impl<R> UnwindSafe for ProgressReader<R>where R: UnwindSafe,

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<R> ReadBytesExt for Rwhere R: Read + ?Sized,

fn read_u8(&mut self) -> Result<u8, Error>

fn read_i8(&mut self) -> Result<i8, Error>

fn read_u16<T>(&mut self) -> Result<u16, Error>where T: ByteOrder,

fn read_i16<T>(&mut self) -> Result<i16, Error>where T: ByteOrder,

fn read_u24<T>(&mut self) -> Result<u32, Error>where T: ByteOrder,

fn read_i24<T>(&mut self) -> Result<i32, Error>where T: ByteOrder,

fn read_u32<T>(&mut self) -> Result<u32, Error>where T: ByteOrder,

fn read_i32<T>(&mut self) -> Result<i32, Error>where T: ByteOrder,

fn read_u48<T>(&mut self) -> Result<u64, Error>where T: ByteOrder,

fn read_i48<T>(&mut self) -> Result<i64, Error>where T: ByteOrder,

fn read_u64<T>(&mut self) -> Result<u64, Error>where T: ByteOrder,

fn read_i64<T>(&mut self) -> Result<i64, Error>where T: ByteOrder,

fn read_u128<T>(&mut self) -> Result<u128, Error>where T: ByteOrder,

fn read_i128<T>(&mut self) -> Result<i128, Error>where T: ByteOrder,

fn read_uint<T>(&mut self, nbytes: usize) -> Result<u64, Error>where T: ByteOrder,

fn read_int<T>(&mut self, nbytes: usize) -> Result<i64, Error>where T: ByteOrder,

fn read_uint128<T>(&mut self, nbytes: usize) -> Result<u128, Error>where T: ByteOrder,

fn read_int128<T>(&mut self, nbytes: usize) -> Result<i128, Error>where T: ByteOrder,

fn read_f32<T>(&mut self) -> Result<f32, Error>where T: ByteOrder,

fn read_f64<T>(&mut self) -> Result<f64, Error>where T: ByteOrder,

fn read_u16_into<T>(&mut self, dst: &mut [u16]) -> Result<(), Error>where T: ByteOrder,

fn read_u32_into<T>(&mut self, dst: &mut [u32]) -> Result<(), Error>where T: ByteOrder,

fn read_u64_into<T>(&mut self, dst: &mut [u64]) -> Result<(), Error>where T: ByteOrder,

fn read_u128_into<T>(&mut self, dst: &mut [u128]) -> Result<(), Error>where T: ByteOrder,

fn read_i8_into(&mut self, dst: &mut [i8]) -> Result<(), Error>

fn read_i16_into<T>(&mut self, dst: &mut [i16]) -> Result<(), Error>where T: ByteOrder,

fn read_i32_into<T>(&mut self, dst: &mut [i32]) -> Result<(), Error>where T: ByteOrder,

fn read_i64_into<T>(&mut self, dst: &mut [i64]) -> Result<(), Error>where T: ByteOrder,

fn read_i128_into<T>(&mut self, dst: &mut [i128]) -> Result<(), Error>where T: ByteOrder,

fn read_f32_into<T>(&mut self, dst: &mut [f32]) -> Result<(), Error>where T: ByteOrder,

fn read_f32_into_unchecked<T>(&mut self, dst: &mut [f32]) -> Result<(), Error>where T: ByteOrder,

fn read_f64_into<T>(&mut self, dst: &mut [f64]) -> Result<(), Error>where T: ByteOrder,

fn read_f64_into_unchecked<T>(&mut self, dst: &mut [f64]) -> Result<(), Error>where T: ByteOrder,

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

pub fn new(inner: R) -> Result<Self, IoError>where
R: ExactLengthReader,

fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,

fn bytes(self) -> Bytes<Self>where
Self: Sized,

fn chain<R>(self, next: R) -> Chain<Self, R>where
R: Read,
Self: Sized,

fn take(self, limit: u64) -> Take<Self>where
Self: Sized,

impl<R> RefUnwindSafe for ProgressReader<R>where
R: RefUnwindSafe,

impl<R> Send for ProgressReader<R>where
R: Send,

impl<R> Sync for ProgressReader<R>where
R: Sync,

impl<R> Unpin for ProgressReader<R>where
R: Unpin,

impl<R> UnwindSafe for ProgressReader<R>where
R: UnwindSafe,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<R> ReadBytesExt for Rwhere
R: Read + ?Sized,

fn read_u16<T>(&mut self) -> Result<u16, Error>where
T: ByteOrder,

fn read_i16<T>(&mut self) -> Result<i16, Error>where
T: ByteOrder,

fn read_u24<T>(&mut self) -> Result<u32, Error>where
T: ByteOrder,

fn read_i24<T>(&mut self) -> Result<i32, Error>where
T: ByteOrder,

fn read_u32<T>(&mut self) -> Result<u32, Error>where
T: ByteOrder,

fn read_i32<T>(&mut self) -> Result<i32, Error>where
T: ByteOrder,

fn read_u48<T>(&mut self) -> Result<u64, Error>where
T: ByteOrder,

fn read_i48<T>(&mut self) -> Result<i64, Error>where
T: ByteOrder,

fn read_u64<T>(&mut self) -> Result<u64, Error>where
T: ByteOrder,

fn read_i64<T>(&mut self) -> Result<i64, Error>where
T: ByteOrder,

fn read_u128<T>(&mut self) -> Result<u128, Error>where
T: ByteOrder,

fn read_i128<T>(&mut self) -> Result<i128, Error>where
T: ByteOrder,

fn read_uint<T>(&mut self, nbytes: usize) -> Result<u64, Error>where
T: ByteOrder,

fn read_int<T>(&mut self, nbytes: usize) -> Result<i64, Error>where
T: ByteOrder,

fn read_uint128<T>(&mut self, nbytes: usize) -> Result<u128, Error>where
T: ByteOrder,

fn read_int128<T>(&mut self, nbytes: usize) -> Result<i128, Error>where
T: ByteOrder,

fn read_f32<T>(&mut self) -> Result<f32, Error>where
T: ByteOrder,

fn read_f64<T>(&mut self) -> Result<f64, Error>where
T: ByteOrder,

fn read_u16_into<T>(&mut self, dst: &mut [u16]) -> Result<(), Error>where
T: ByteOrder,

fn read_u32_into<T>(&mut self, dst: &mut [u32]) -> Result<(), Error>where
T: ByteOrder,

fn read_u64_into<T>(&mut self, dst: &mut [u64]) -> Result<(), Error>where
T: ByteOrder,

fn read_u128_into<T>(&mut self, dst: &mut [u128]) -> Result<(), Error>where
T: ByteOrder,

fn read_i16_into<T>(&mut self, dst: &mut [i16]) -> Result<(), Error>where
T: ByteOrder,

fn read_i32_into<T>(&mut self, dst: &mut [i32]) -> Result<(), Error>where
T: ByteOrder,

fn read_i64_into<T>(&mut self, dst: &mut [i64]) -> Result<(), Error>where
T: ByteOrder,

fn read_i128_into<T>(&mut self, dst: &mut [i128]) -> Result<(), Error>where
T: ByteOrder,

fn read_f32_into<T>(&mut self, dst: &mut [f32]) -> Result<(), Error>where
T: ByteOrder,

fn read_f32_into_unchecked<T>(&mut self, dst: &mut [f32]) -> Result<(), Error>where
T: ByteOrder,

fn read_f64_into<T>(&mut self, dst: &mut [f64]) -> Result<(), Error>where
T: ByteOrder,

fn read_f64_into_unchecked<T>(&mut self, dst: &mut [f64]) -> Result<(), Error>where
T: ByteOrder,

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

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,