snarkvm_utilities::serialize::io

Struct BorrowedCursor

Source
pub struct BorrowedCursor<'a> { /* private fields */ }
๐Ÿ”ฌThis is a nightly-only experimental API. (core_io_borrowed_buf)
Expand description

A writeable view of the unfilled portion of a BorrowedBuf.

The unfilled portion consists of an initialized and an uninitialized part; see BorrowedBuf for details.

Data can be written directly to the cursor by using append or indirectly by getting a slice of part or all of the cursor and writing into the slice. In the indirect case, the caller must call advance after writing to inform the cursor how many bytes have been written.

Once data is written to the cursor, it becomes part of the filled portion of the underlying BorrowedBuf and can no longer be accessed or re-written by the cursor. I.e., the cursor tracks the unfilled part of the underlying BorrowedBuf.

The lifetime 'a is a bound on the lifetime of the underlying buffer (which means it is a bound on the data in that buffer by transitivity).

Implementationsยง

Sourceยง

impl<'a> BorrowedCursor<'a>

Source

pub fn reborrow<'this>(&'this mut self) -> BorrowedCursor<'this> โ“˜

๐Ÿ”ฌThis is a nightly-only experimental API. (core_io_borrowed_buf)

Reborrows this cursor by cloning it with a smaller lifetime.

Since a cursor maintains unique access to its underlying buffer, the borrowed cursor is not accessible while the new cursor exists.

Source

pub fn capacity(&self) -> usize

๐Ÿ”ฌThis is a nightly-only experimental API. (core_io_borrowed_buf)

Returns the available space in the cursor.

Source

pub fn written(&self) -> usize

๐Ÿ”ฌThis is a nightly-only experimental API. (core_io_borrowed_buf)

Returns the number of bytes written to this cursor since it was created from a BorrowedBuf.

Note that if this cursor is a reborrowed clone of another, then the count returned is the count written via either cursor, not the count since the cursor was reborrowed.

Source

pub fn init_ref(&self) -> &[u8] โ“˜

๐Ÿ”ฌThis is a nightly-only experimental API. (core_io_borrowed_buf)

Returns a shared reference to the initialized portion of the cursor.

Source

pub fn init_mut(&mut self) -> &mut [u8] โ“˜

๐Ÿ”ฌThis is a nightly-only experimental API. (core_io_borrowed_buf)

Returns a mutable reference to the initialized portion of the cursor.

Source

pub fn uninit_mut(&mut self) -> &mut [MaybeUninit<u8>]

๐Ÿ”ฌThis is a nightly-only experimental API. (core_io_borrowed_buf)

Returns a mutable reference to the uninitialized part of the cursor.

It is safe to uninitialize any of these bytes.

Source

pub unsafe fn as_mut(&mut self) -> &mut [MaybeUninit<u8>]

๐Ÿ”ฌThis is a nightly-only experimental API. (core_io_borrowed_buf)

Returns a mutable reference to the whole cursor.

ยงSafety

The caller must not uninitialize any bytes in the initialized portion of the cursor.

Source

pub fn advance(&mut self, n: usize) -> &mut BorrowedCursor<'a> โ“˜

๐Ÿ”ฌThis is a nightly-only experimental API. (core_io_borrowed_buf)

Advances the cursor by asserting that n bytes have been filled.

After advancing, the n bytes are no longer accessible via the cursor and can only be accessed via the underlying buffer. I.e., the bufferโ€™s filled portion grows by n elements and its unfilled portion (and the capacity of this cursor) shrinks by n elements.

If less than n bytes initialized (by the cursorโ€™s point of view), set_init should be called first.

ยงPanics

Panics if there are less than n bytes initialized.

Source

pub unsafe fn advance_unchecked(&mut self, n: usize) -> &mut BorrowedCursor<'a> โ“˜

๐Ÿ”ฌThis is a nightly-only experimental API. (core_io_borrowed_buf)

Advances the cursor by asserting that n bytes have been filled.

After advancing, the n bytes are no longer accessible via the cursor and can only be accessed via the underlying buffer. I.e., the bufferโ€™s filled portion grows by n elements and its unfilled portion (and the capacity of this cursor) shrinks by n elements.

ยงSafety

The caller must ensure that the first n bytes of the cursor have been properly initialised.

Source

pub fn ensure_init(&mut self) -> &mut BorrowedCursor<'a> โ“˜

๐Ÿ”ฌThis is a nightly-only experimental API. (core_io_borrowed_buf)

Initializes all bytes in the cursor.

Source

pub unsafe fn set_init(&mut self, n: usize) -> &mut BorrowedCursor<'a> โ“˜

๐Ÿ”ฌThis is a nightly-only experimental API. (core_io_borrowed_buf)

Asserts that the first n unfilled bytes of the cursor are initialized.

BorrowedBuf assumes that bytes are never de-initialized, so this method does nothing when called with fewer bytes than are already known to be initialized.

ยงSafety

The caller must ensure that the first n bytes of the buffer have already been initialized.

Source

pub fn append(&mut self, buf: &[u8])

๐Ÿ”ฌThis is a nightly-only experimental API. (core_io_borrowed_buf)

Appends data to the cursor, advancing position within its buffer.

ยงPanics

Panics if self.capacity() is less than buf.len().

Trait Implementationsยง

Sourceยง

impl<'a> Debug for BorrowedCursor<'a>

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl<'a> Write for BorrowedCursor<'a>

Sourceยง

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

Writes a buffer into this writer, returning how many bytes were written. Read more
Sourceยง

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
1.36.0 ยท Sourceยง

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

Like write, except that it writes from a slice of buffers. Read more
Sourceยง

fn is_write_vectored(&self) -> bool

๐Ÿ”ฌThis is a nightly-only experimental API. (can_vector)
Determines if this Writer has an efficient write_vectored implementation. Read more
1.0.0 ยท Sourceยง

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

Attempts to write an entire buffer into this writer. Read more
Sourceยง

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

๐Ÿ”ฌThis is a nightly-only experimental API. (write_all_vectored)
Attempts to write multiple buffers into this writer. Read more
1.0.0 ยท Sourceยง

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 ยท Sourceยง

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

Creates a โ€œby referenceโ€ adapter for this instance of Write. Read more

Auto Trait Implementationsยง

ยง

impl<'a> Freeze for BorrowedCursor<'a>

ยง

impl<'a> RefUnwindSafe for BorrowedCursor<'a>

ยง

impl<'a> Send for BorrowedCursor<'a>

ยง

impl<'a> Sync for BorrowedCursor<'a>

ยง

impl<'a> Unpin for BorrowedCursor<'a>

ยง

impl<'a> !UnwindSafe for BorrowedCursor<'a>

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, 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> IntoEither for T

Sourceยง

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Sourceยง

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Sourceยง

impl<T> Pointable for T

Sourceยง

const ALIGN: usize = _

The alignment of pointer.
Sourceยง

type Init = T

The type for initializers.
Sourceยง

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Sourceยง

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Sourceยง

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Sourceยง

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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