Struct futures_util::io::Window

source ·
pub struct Window<T> { /* private fields */ }
Available on crate feature io only.
Expand description

An 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: AsRef<[u8]>> Window<T>

source

pub fn new(t: T) -> Self

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.

source

pub fn get_ref(&self) -> &T

Gets a shared reference to the underlying buffer inside of this Window.

source

pub fn get_mut(&mut self) -> &mut T

Gets a mutable reference to the underlying buffer inside of this Window.

source

pub fn into_inner(self) -> T

Consumes this Window, returning the underlying buffer.

source

pub fn start(&self) -> usize

Returns the starting index of this window into the underlying buffer T.

source

pub fn end(&self) -> usize

Returns the end index of this window into the underlying buffer T.

source

pub fn set<R: RangeBounds<usize>>(&mut self, range: R)

Changes the range of this window to the range specified.

§Panics

This method will panic if range is out of bounds for the underlying slice or if start_bound() of range comes after the end_bound().

Trait Implementations§

source§

impl<T: AsMut<[u8]>> AsMut<[u8]> for Window<T>

source§

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.
source§

impl<T: AsRef<[u8]>> AsRef<[u8]> for Window<T>

source§

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl<T: Debug> Debug for Window<T>

source§

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

Formats the value using the given formatter. Read more

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> 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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.