Struct ic_cdk::api::stable::StableReader

source ·

pub struct StableReader<M: StableMemory = CanisterStableMemory>(_);

Expand description

Keeps an offset and reads off stable memory consecutively.

Implementations

source

impl<M: StableMemory> StableReader<M>

source

pub fn with_memory(memory: M, offset: usize) -> Self

Creates a new StableReader which reads from the selected memory

source

pub fn offset(&self) -> usize

Returns the offset of the reader

source

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

Reads data from the stable memory location specified by an offset.

Note: The stable memory size is cached on creation of the StableReader. Therefore, in following scenario, it will get an OutOfBounds error:

Create a StableReader
Write some data to the stable memory which causes it grow
call read() to read the newly written bytes

Trait Implementations

source

impl Default for StableReader

source

fn default() -> Self

Returns the “default value” for a type. Read more

source

impl<M: StableMemory> From<StableIO<M, u32>> for StableReader<M>

source

fn from(io: StableIO<M>) -> Self

Converts to this type from the input type.

source

impl<M: StableMemory> Read for StableReader<M>

source

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more

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

source

impl<M: StableMemory> Seek for StableReader<M>

source

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream. Read more

1.55.0 · source

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

Rewind to the beginning of a stream. Read more

source

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

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

Returns the length of this stream (in bytes). Read more

1.51.0 · source

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

Returns the current seek position from the start of the stream. Read more

Auto Trait Implementations

impl<M> RefUnwindSafe for StableReader<M>where
M: RefUnwindSafe,

impl<M> Send for StableReader<M>where
M: Send,

impl<M> Sync for StableReader<M>where
M: Sync,

impl<M> Unpin for StableReader<M>where
M: Unpin,

impl<M> UnwindSafe for StableReader<M>where
M: UnwindSafe,

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<R> BinReaderExt for Rwhere
R: Read + Seek,

fn read_type<T>(&mut self, endian: Endian) -> Result<T, Error>where
T: BinRead,

Read the given type from the reader using the given endianness.

fn read_be<T>(&mut self) -> Result<T, Error>where
T: BinRead,

Read the given type from the reader with big endian byteorder

fn read_le<T>(&mut self) -> Result<T, Error>where
T: BinRead,

Read the given type from the reader with little endian byteorder

fn read_ne<T>(&mut self) -> Result<T, Error>where
T: BinRead,

Read the given type from the reader with the native byteorder

fn read_type_args<T>(
 &mut self,
 endian: Endian,
 args: <T as BinRead>::Args
) -> Result<T, Error>where
 T: BinRead,

Read T from the reader with the given byte order and arguments.

fn read_be_args<T>(&mut self, args: <T as BinRead>::Args) -> Result<T, Error>where
T: BinRead,

Read T from the reader, assuming big-endian byte order, using the given arguments. Read more

fn read_le_args<T>(&mut self, args: <T as BinRead>::Args) -> Result<T, Error>where
T: BinRead,

Read T from the reader, assuming little-endian byte order, using the given arguments. Read more

fn read_ne_args<T>(&mut self, args: <T as BinRead>::Args) -> Result<T, Error>where
T: BinRead,

Read T from the reader, assuming native-endian byte order, using the given arguments. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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.

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

impl<T> StreamPosition for Twhere
T: Seek,

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

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 ic_cdk::api::stable::StableReader

Implementations

impl<M: StableMemory> StableReader<M>

pub fn with_memory(memory: M, offset: usize) -> Self

pub fn offset(&self) -> usize

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

Trait Implementations

impl Default for StableReader

fn default() -> Self

impl<M: StableMemory> From<StableIO<M, u32>> for StableReader<M>

fn from(io: StableIO<M>) -> Self

impl<M: StableMemory> Read for StableReader<M>

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,

impl<M: StableMemory> Seek for StableReader<M>

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

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

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

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

Auto Trait Implementations

impl<M> RefUnwindSafe for StableReader<M>where M: RefUnwindSafe,

impl<M> Send for StableReader<M>where M: Send,

impl<M> Sync for StableReader<M>where M: Sync,

impl<M> Unpin for StableReader<M>where M: Unpin,

impl<M> UnwindSafe for StableReader<M>where M: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<R> BinReaderExt for Rwhere R: Read + Seek,

fn read_type<T>(&mut self, endian: Endian) -> Result<T, Error>where T: BinRead,

fn read_be<T>(&mut self) -> Result<T, Error>where T: BinRead,

fn read_le<T>(&mut self) -> Result<T, Error>where T: BinRead,

fn read_ne<T>(&mut self) -> Result<T, Error>where T: BinRead,

fn read_type_args<T>( &mut self, endian: Endian, args: <T as BinRead>::Args) -> Result<T, Error>where T: BinRead,

fn read_be_args<T>(&mut self, args: <T as BinRead>::Args) -> Result<T, Error>where T: BinRead,

fn read_le_args<T>(&mut self, args: <T as BinRead>::Args) -> Result<T, Error>where T: BinRead,

fn read_ne_args<T>(&mut self, args: <T as BinRead>::Args) -> Result<T, Error>where T: BinRead,

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 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<M> RefUnwindSafe for StableReader<M>where
M: RefUnwindSafe,

impl<M> Send for StableReader<M>where
M: Send,

impl<M> Sync for StableReader<M>where
M: Sync,

impl<M> Unpin for StableReader<M>where
M: Unpin,

impl<M> UnwindSafe for StableReader<M>where
M: UnwindSafe,

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

impl<R> BinReaderExt for Rwhere
R: Read + Seek,

fn read_type<T>(&mut self, endian: Endian) -> Result<T, Error>where
T: BinRead,

fn read_be<T>(&mut self) -> Result<T, Error>where
T: BinRead,

fn read_le<T>(&mut self) -> Result<T, Error>where
T: BinRead,

fn read_ne<T>(&mut self) -> Result<T, Error>where
T: BinRead,

fn read_type_args<T>(
&mut self,
endian: Endian,
args: <T as BinRead>::Args
) -> Result<T, Error>where
T: BinRead,

fn read_be_args<T>(&mut self, args: <T as BinRead>::Args) -> Result<T, Error>where
T: BinRead,

fn read_le_args<T>(&mut self, args: <T as BinRead>::Args) -> Result<T, Error>where
T: BinRead,

fn read_ne_args<T>(&mut self, args: <T as BinRead>::Args) -> Result<T, Error>where
T: BinRead,

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> StreamPosition for Twhere
T: Seek,

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

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