pub struct BorrowedCursor<'a, T> {
buf: NonNull<MaybeUninit<T>>,
borrowed_buf: NonNull<BorrowedBuf<'a, T>>,
}core_io_borrowed_buf)Expand description
A writeable view of the unfilled portion of a BorrowedBuf.
The unfilled portion may be uninitialized; 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 elements have been written.
Once elements are written to the cursor, they become part of the filled portion of the
underlying BorrowedBuf and can no longer be accessed or re-written by the cursor. In other
words, 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 elements in that buffer by transitivity).
Fields§
§buf: NonNull<MaybeUninit<T>>core_io_borrowed_buf)borrowed_buf: NonNull<BorrowedBuf<'a, T>>core_io_borrowed_buf)Implementations§
Source§impl<'a, T> BorrowedCursor<'a, T>where
T: Copy,
impl<'a, T> BorrowedCursor<'a, T>where
T: Copy,
Sourcepub fn reborrow<'this>(&'this mut self) -> BorrowedCursor<'this, T>
🔬This is a nightly-only experimental API. (core_io_borrowed_buf)
pub fn reborrow<'this>(&'this mut self) -> BorrowedCursor<'this, T>
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.
Sourcepub fn capacity(&self) -> usize
🔬This is a nightly-only experimental API. (core_io_borrowed_buf)
pub fn capacity(&self) -> usize
core_io_borrowed_buf)Returns the available space in the cursor.
Sourcepub fn written(&self) -> usize
🔬This is a nightly-only experimental API. (core_io_borrowed_buf)
pub fn written(&self) -> usize
core_io_borrowed_buf)Returns the number of elements written to the BorrowedBuf this cursor was created from.
In particular, the count returned is shared by all reborrows of the cursor.
Sourcepub fn is_init(&self) -> bool
🔬This is a nightly-only experimental API. (borrowed_buf_init)
pub fn is_init(&self) -> bool
borrowed_buf_init)Returns true if the buffer is initialized.
Sourcepub unsafe fn set_init(&mut self)
🔬This is a nightly-only experimental API. (borrowed_buf_init)
pub unsafe fn set_init(&mut self)
borrowed_buf_init)Sourcepub unsafe fn as_mut(&mut self) -> &mut [MaybeUninit<T>]
🔬This is a nightly-only experimental API. (core_io_borrowed_buf)
pub unsafe fn as_mut(&mut self) -> &mut [MaybeUninit<T>]
core_io_borrowed_buf)Returns a mutable reference to the whole cursor.
§Safety
The caller must not uninitialize any elements of the cursor if it is initialized.
Sourcepub fn advance_checked(&mut self, n: usize) -> &mut BorrowedCursor<'a, T>
🔬This is a nightly-only experimental API. (borrowed_buf_init)
pub fn advance_checked(&mut self, n: usize) -> &mut BorrowedCursor<'a, T>
borrowed_buf_init)Advances the cursor by asserting that n elements have been filled.
After advancing, the n elements 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 elements initialized (by the cursor’s point of view), set_init should be
called first.
§Panics
Panics if there are less than n elements initialized.
Sourcepub unsafe fn advance(&mut self, n: usize) -> &mut BorrowedCursor<'a, T>
🔬This is a nightly-only experimental API. (core_io_borrowed_buf)
pub unsafe fn advance(&mut self, n: usize) -> &mut BorrowedCursor<'a, T>
core_io_borrowed_buf)Advances the cursor by asserting that n elements have been filled.
After advancing, the n elements 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 elements of the cursor have been initialized.
Sourcepub fn append(&mut self, buf: &[T])
🔬This is a nightly-only experimental API. (core_io_borrowed_buf)
pub fn append(&mut self, buf: &[T])
core_io_borrowed_buf)Append elements to the cursor, advancing position within its buffer.
§Panics
Panics if self.capacity() is less than buf.len().
Sourcepub fn with_unfilled_buf<R>(
&mut self,
f: impl FnOnce(&mut BorrowedBuf<'_, T>) -> R,
) -> R
🔬This is a nightly-only experimental API. (core_io_borrowed_buf)
pub fn with_unfilled_buf<R>( &mut self, f: impl FnOnce(&mut BorrowedBuf<'_, T>) -> R, ) -> R
core_io_borrowed_buf)Runs the given closure with a BorrowedBuf containing the unfilled part
of the cursor.
This enables inspecting what was written to the cursor.
§Panics
Panics if the BorrowedBuf given to the closure is replaced by another
one.
Source§impl<'a, T> BorrowedCursor<'a, T>
impl<'a, T> BorrowedCursor<'a, T>
Sourcepub fn ensure_init(&mut self) -> &mut [T]
🔬This is a nightly-only experimental API. (borrowed_buf_init)
pub fn ensure_init(&mut self) -> &mut [T]
borrowed_buf_init)Initializes all elements in the cursor with their default value and returns them.
Trait Implementations§
Source§impl<T> Debug for BorrowedCursor<'_, T>
impl<T> Debug for BorrowedCursor<'_, T>
Source§impl<'data, T> From<BorrowedCursor<'data, T>> for BorrowedBuf<'data, T>where
T: Copy,
Creates a new BorrowedBuf from a cursor.
impl<'data, T> From<BorrowedCursor<'data, T>> for BorrowedBuf<'data, T>where
T: Copy,
Creates a new BorrowedBuf from a cursor.
Use BorrowedCursor::with_unfilled_buf instead for a safer alternative.
Source§fn from(buf: BorrowedCursor<'data, T>) -> BorrowedBuf<'data, T>
fn from(buf: BorrowedCursor<'data, T>) -> BorrowedBuf<'data, T>
impl<T> Send for BorrowedCursor<'_, T>where
T: Send,
impl<T> Sync for BorrowedCursor<'_, T>where
T: Sync,
Source§impl<'a> Write for BorrowedCursor<'a, u8>
impl<'a> Write for BorrowedCursor<'a, u8>
Source§fn write(&mut self, buf: &[u8]) -> Result<usize, Error>
fn write(&mut self, buf: &[u8]) -> Result<usize, Error>
Source§fn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
can_vector)Source§fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
Source§fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
write_all_vectored)Source§fn flush(&mut self) -> Result<(), Error>
fn flush(&mut self) -> Result<(), Error>
Auto Trait Implementations§
impl<'a, T> Forget for BorrowedCursor<'a, T>
impl<'a, T> Freeze for BorrowedCursor<'a, T>
impl<'a, T> Move for BorrowedCursor<'a, T>
impl<'a, T> RefUnwindSafe for BorrowedCursor<'a, T>
impl<'a, T> Unpin for BorrowedCursor<'a, T>
impl<'a, T> UnsafeUnpin for BorrowedCursor<'a, T>
impl<'a, T> UnwindSafe for BorrowedCursor<'a, T>
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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 moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> PossiblyOption<T> for T
impl<T> PossiblyOption<T> for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.