pub struct Window<T> { /* private fields */ }
Expand description
A owned window around an underlying buffer.
Normally slices work great for considering sub-portions of a buffer, but unfortunately a slice is a borrowed type in Rust which has an associated lifetime. When working with future and async I/O these lifetimes are not always appropriate, and are sometimes difficult to store in tasks. This type strives to fill this gap by providing an “owned slice” around an underlying buffer of bytes.
A Window<T>
wraps an underlying buffer, T
, and has configurable
start/end indexes to alter the behavior of the AsRef<[u8]>
implementation
that this type carries.
This type can be particularly useful when working with the write_all
combinator in this crate. Data can be sliced via Window
, consumed by
write_all
, and then earned back once the write operation finishes through
the into_inner
method on this type.
Implementations§
Source§impl<T> Window<T>
impl<T> Window<T>
Sourcepub fn new(t: T) -> Window<T>
pub fn new(t: T) -> Window<T>
Creates a new window around the buffer t
defaulting to the entire
slice.
Further methods can be called on the returned Window<T>
to alter the
window into the data provided.
Sourcepub fn get_ref(&self) -> &T
pub fn get_ref(&self) -> &T
Gets a shared reference to the underlying buffer inside of this
Window
.
Sourcepub fn get_mut(&mut self) -> &mut T
pub fn get_mut(&mut self) -> &mut T
Gets a mutable reference to the underlying buffer inside of this
Window
.
Sourcepub fn into_inner(self) -> T
pub fn into_inner(self) -> T
Consumes this Window
, returning the underlying buffer.
Sourcepub fn start(&self) -> usize
pub fn start(&self) -> usize
Returns the starting index of this window into the underlying buffer
T
.
Sourcepub fn set_start(&mut self, start: usize) -> &mut Window<T>
pub fn set_start(&mut self, start: usize) -> &mut Window<T>
Changes the starting index of this window to the index specified.
Returns the windows back to chain multiple calls to this method.
§Panics
This method will panic if start
is out of bounds for the underlying
slice or if it comes after the end
configured in this window.
Sourcepub fn set_end(&mut self, end: usize) -> &mut Window<T>
pub fn set_end(&mut self, end: usize) -> &mut Window<T>
Changes the end index of this window to the index specified.
Returns the windows back to chain multiple calls to this method.
§Panics
This method will panic if end
is out of bounds for the underlying
slice or if it comes before the start
configured in this window.
Trait Implementations§
Auto Trait Implementations§
impl<T> Freeze for Window<T>where
T: Freeze,
impl<T> RefUnwindSafe for Window<T>where
T: RefUnwindSafe,
impl<T> Send for Window<T>where
T: Send,
impl<T> Sync for Window<T>where
T: Sync,
impl<T> Unpin for Window<T>where
T: Unpin,
impl<T> UnwindSafe for Window<T>where
T: UnwindSafe,
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
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