[−][src]Struct futures_util::io::Window
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.
Methods
impl<T: AsRef<[u8]>> Window<T>
[src]
impl<T: AsRef<[u8]>> Window<T>
pub fn new(t: T) -> Window<T>
[src]
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.
ⓘImportant traits for &'_ mut Ipub fn get_ref(&self) -> &T
[src]
pub fn get_ref(&self) -> &T
Gets a shared reference to the underlying buffer inside of this
Window
.
ⓘImportant traits for &'_ mut Ipub fn get_mut(&mut self) -> &mut T
[src]
pub fn get_mut(&mut self) -> &mut T
Gets a mutable reference to the underlying buffer inside of this
Window
.
pub fn into_inner(self) -> T
[src]
pub fn into_inner(self) -> T
Consumes this Window
, returning the underlying buffer.
pub fn start(&self) -> usize
[src]
pub fn start(&self) -> usize
Returns the starting index of this window into the underlying buffer
T
.
pub fn end(&self) -> usize
[src]
pub fn end(&self) -> usize
Returns the end index of this window into the underlying buffer
T
.
pub fn set_start(&mut self, start: usize) -> &mut Window<T>
[src]
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.
pub fn set_end(&mut self, end: usize) -> &mut Window<T>
[src]
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
impl<T: AsMut<[u8]>> AsMut<[u8]> for Window<T>
[src]
impl<T: AsMut<[u8]>> AsMut<[u8]> for Window<T>
impl<T: AsRef<[u8]>> AsRef<[u8]> for Window<T>
[src]
impl<T: AsRef<[u8]>> AsRef<[u8]> for Window<T>
impl<T: Debug> Debug for Window<T>
[src]
impl<T: Debug> Debug for Window<T>
Auto Trait Implementations
Blanket Implementations
impl<T, U> Into for T where
U: From<T>,
[src]
impl<T, U> Into for T where
U: From<T>,
impl<T> From for T
[src]
impl<T> From for T
impl<T, U> TryFrom for T where
T: From<U>,
[src]
impl<T, U> TryFrom for T where
T: From<U>,
type Error = !
try_from
)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
try_from
)Performs the conversion.
impl<T> Borrow for T where
T: ?Sized,
[src]
impl<T> Borrow for T where
T: ?Sized,
ⓘImportant traits for &'_ mut Ifn borrow(&self) -> &T
[src]
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Any for T where
T: 'static + ?Sized,
fn get_type_id(&self) -> TypeId
[src]
fn get_type_id(&self) -> TypeId
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static
Gets the TypeId
of self
. Read more
impl<T> BorrowMut for T where
T: ?Sized,
[src]
impl<T> BorrowMut for T where
T: ?Sized,
ⓘImportant traits for &'_ mut Ifn borrow_mut(&mut self) -> &mut T
[src]
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,