Struct tor_hsservice::internal_prelude::io::BorrowedCursor
source · pub struct BorrowedCursor<'a> {
buf: &'a mut BorrowedBuf<'a>,
start: usize,
}
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).
Fields§
§buf: &'a mut BorrowedBuf<'a>
core_io_borrowed_buf
)start: usize
core_io_borrowed_buf
)Implementations§
source§impl<'a> BorrowedCursor<'a>
impl<'a> BorrowedCursor<'a>
sourcepub fn reborrow<'this>(&'this mut self) -> BorrowedCursor<'this> ⓘ
🔬This is a nightly-only experimental API. (core_io_borrowed_buf
)
pub fn reborrow<'this>(&'this mut self) -> BorrowedCursor<'this> ⓘ
core_io_borrowed_buf
)Reborrow 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 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.
sourcepub fn init_ref(&self) -> &[u8] ⓘ
🔬This is a nightly-only experimental API. (core_io_borrowed_buf
)
pub fn init_ref(&self) -> &[u8] ⓘ
core_io_borrowed_buf
)Returns a shared reference to the initialized portion of the cursor.
sourcepub fn init_mut(&mut self) -> &mut [u8] ⓘ
🔬This is a nightly-only experimental API. (core_io_borrowed_buf
)
pub fn init_mut(&mut self) -> &mut [u8] ⓘ
core_io_borrowed_buf
)Returns a mutable reference to the initialized portion of the cursor.
sourcepub fn uninit_mut(&mut self) -> &mut [MaybeUninit<u8>]
🔬This is a nightly-only experimental API. (core_io_borrowed_buf
)
pub fn uninit_mut(&mut self) -> &mut [MaybeUninit<u8>]
core_io_borrowed_buf
)Returns a mutable reference to the uninitialized part of the cursor.
It is safe to uninitialize any of these bytes.
sourcepub unsafe fn as_mut(&mut self) -> &mut [MaybeUninit<u8>]
🔬This is a nightly-only experimental API. (core_io_borrowed_buf
)
pub unsafe fn as_mut(&mut self) -> &mut [MaybeUninit<u8>]
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.
sourcepub fn advance(&mut self, n: usize) -> &mut BorrowedCursor<'a> ⓘ
🔬This is a nightly-only experimental API. (core_io_borrowed_buf
)
pub fn advance(&mut self, n: usize) -> &mut BorrowedCursor<'a> ⓘ
core_io_borrowed_buf
)Advance 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.
sourcepub unsafe fn advance_unchecked(&mut self, n: usize) -> &mut BorrowedCursor<'a> ⓘ
🔬This is a nightly-only experimental API. (core_io_borrowed_buf
)
pub unsafe fn advance_unchecked(&mut self, n: usize) -> &mut BorrowedCursor<'a> ⓘ
core_io_borrowed_buf
)Advance 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.
sourcepub fn ensure_init(&mut self) -> &mut BorrowedCursor<'a> ⓘ
🔬This is a nightly-only experimental API. (core_io_borrowed_buf
)
pub fn ensure_init(&mut self) -> &mut BorrowedCursor<'a> ⓘ
core_io_borrowed_buf
)Initializes all bytes in the cursor.
sourcepub unsafe fn set_init(&mut self, n: usize) -> &mut BorrowedCursor<'a> ⓘ
🔬This is a nightly-only experimental API. (core_io_borrowed_buf
)
pub unsafe fn set_init(&mut self, n: usize) -> &mut BorrowedCursor<'a> ⓘ
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.
Trait Implementations§
source§impl<'a> Debug for BorrowedCursor<'a>
impl<'a> Debug for BorrowedCursor<'a>
source§impl<'a> Write for BorrowedCursor<'a>
impl<'a> Write for BorrowedCursor<'a>
source§fn write(&mut self, buf: &[u8]) -> Result<usize, Error>
fn write(&mut self, buf: &[u8]) -> Result<usize, Error>
source§fn flush(&mut self) -> Result<(), Error>
fn flush(&mut self) -> Result<(), Error>
source§fn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
can_vector
)1.0.0 · 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
)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> 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<T> Conv for T
impl<T> Conv for T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§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>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§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>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§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.§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.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§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.§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.§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.§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.§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.§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.§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.§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.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> 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 more§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§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 more§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 more§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
§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
§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.§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.§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.§impl<T> Tap for T
impl<T> Tap for T
§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 more§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 more§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 more§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 more§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 more§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 more§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.§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.§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.§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.§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.§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.§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.