Struct futures::io::Window

source ·
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§

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.

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

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

Consumes this Window, returning the underlying buffer.

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

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

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§

Converts this type into a mutable reference of the (usually inferred) input type.
Converts this type into a shared reference of the (usually inferred) input type.
Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.