| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A owned window around an underlying buffer."><meta name="keywords" content="rust, rustlang, rust-lang, Window"><title>Window in futures::io - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../futures/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../futures/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Window</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.end">end</a></li><li><a href="#method.get_mut">get_mut</a></li><li><a href="#method.get_ref">get_ref</a></li><li><a href="#method.into_inner">into_inner</a></li><li><a href="#method.new">new</a></li><li><a href="#method.set">set</a></li><li><a href="#method.start">start</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-AsMut%3C%5Bu8%5D%3E-for-Window%3CT%3E">AsMut<[u8]></a></li><li><a href="#impl-AsRef%3C%5Bu8%5D%3E-for-Window%3CT%3E">AsRef<[u8]></a></li><li><a href="#impl-Debug-for-Window%3CT%3E">Debug</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Window%3CT%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Window%3CT%3E">Send</a></li><li><a href="#impl-Sync-for-Window%3CT%3E">Sync</a></li><li><a href="#impl-Unpin-for-Window%3CT%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Window%3CT%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Window%3CT%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Window%3CT%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Window%3CT%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-Window%3CT%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-Window%3CT%3E">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-Window%3CT%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-Window%3CT%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In futures::io</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="../index.html">futures</a>::<wbr><a href="index.html">io</a>::<wbr><a class="struct" href="#">Window</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/futures_util/io/window.rs.html#21">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct Window<T> { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A owned window around an underlying buffer.</p> |
| <p>Normally slices work great for considering sub-portions of a buffer, but |
| unfortunately a slice is a <em>borrowed</em> 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.</p> |
| <p>A <code>Window<T></code> wraps an underlying buffer, <code>T</code>, and has configurable |
| start/end indexes to alter the behavior of the <code>AsRef<[u8]></code> implementation |
| that this type carries.</p> |
| <p>This type can be particularly useful when working with the <code>write_all</code> |
| combinator in this crate. Data can be sliced via <code>Window</code>, consumed by |
| <code>write_all</code>, and then earned back once the write operation finishes through |
| the <code>into_inner</code> method on this type.</p> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Window%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/window.rs.html#26">source</a><a href="#impl-Window%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="struct" href="struct.Window.html" title="struct futures::io::Window">Window</a><T><span class="where fmt-newline">where<br> T: AsRef<[u8]>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/window.rs.html#32">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>(t: T) -> <a class="struct" href="struct.Window.html" title="struct futures::io::Window">Window</a><T></h4></section></summary><div class="docblock"><p>Creates a new window around the buffer <code>t</code> defaulting to the entire |
| slice.</p> |
| <p>Further methods can be called on the returned <code>Window<T></code> to alter the |
| window into the data provided.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_ref" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/window.rs.html#38">source</a><h4 class="code-header">pub fn <a href="#method.get_ref" class="fnname">get_ref</a>(&self) -> &T</h4></section></summary><div class="docblock"><p>Gets a shared reference to the underlying buffer inside of this |
| <code>Window</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_mut" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/window.rs.html#44">source</a><h4 class="code-header">pub fn <a href="#method.get_mut" class="fnname">get_mut</a>(&mut self) -> &mut T</h4></section></summary><div class="docblock"><p>Gets a mutable reference to the underlying buffer inside of this |
| <code>Window</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_inner" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/window.rs.html#49">source</a><h4 class="code-header">pub fn <a href="#method.into_inner" class="fnname">into_inner</a>(self) -> T</h4></section></summary><div class="docblock"><p>Consumes this <code>Window</code>, returning the underlying buffer.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.start" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/window.rs.html#55">source</a><h4 class="code-header">pub fn <a href="#method.start" class="fnname">start</a>(&self) -> usize</h4></section></summary><div class="docblock"><p>Returns the starting index of this window into the underlying buffer |
| <code>T</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.end" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/window.rs.html#61">source</a><h4 class="code-header">pub fn <a href="#method.end" class="fnname">end</a>(&self) -> usize</h4></section></summary><div class="docblock"><p>Returns the end index of this window into the underlying buffer |
| <code>T</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.set" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/window.rs.html#74">source</a><h4 class="code-header">pub fn <a href="#method.set" class="fnname">set</a><R>(&mut self, range: R)<span class="where fmt-newline">where<br> R: RangeBounds<usize>,</span></h4></section></summary><div class="docblock"><p>Changes the range of this window to the range specified.</p> |
| <h5 id="panics"><a href="#panics">Panics</a></h5> |
| <p>This method will panic if <code>range</code> is out of bounds for the underlying |
| slice or if <a href="std::ops::RangeBounds::start_bound"><code>start_bound()</code></a> of <code>range</code> comes after the <a href="std::ops::RangeBounds::end_bound"><code>end_bound()</code></a>.</p> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-AsMut%3C%5Bu8%5D%3E-for-Window%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/window.rs.html#100">source</a><a href="#impl-AsMut%3C%5Bu8%5D%3E-for-Window%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> AsMut<[u8]> for <a class="struct" href="struct.Window.html" title="struct futures::io::Window">Window</a><T><span class="where fmt-newline">where<br> T: AsMut<[u8]>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_mut" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/window.rs.html#101">source</a><a href="#method.as_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">as_mut</a>(&mut self) -> &mut [u8]</h4></section></summary><div class='docblock'>Converts this type into a mutable reference of the (usually inferred) input type.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-AsRef%3C%5Bu8%5D%3E-for-Window%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/window.rs.html#94">source</a><a href="#impl-AsRef%3C%5Bu8%5D%3E-for-Window%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> AsRef<[u8]> for <a class="struct" href="struct.Window.html" title="struct futures::io::Window">Window</a><T><span class="where fmt-newline">where<br> T: AsRef<[u8]>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_ref" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/window.rs.html#95">source</a><a href="#method.as_ref" class="anchor"></a><h4 class="code-header">fn <a class="fnname">as_ref</a>(&self) -> &[u8]</h4></section></summary><div class='docblock'>Converts this type into a shared reference of the (usually inferred) input type.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-Window%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/window.rs.html#20">source</a><a href="#impl-Debug-for-Window%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Debug for <a class="struct" href="struct.Window.html" title="struct futures::io::Window">Window</a><T><span class="where fmt-newline">where<br> T: Debug,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/io/window.rs.html#20">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result<(), Error></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-Window%3CT%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Window%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> RefUnwindSafe for <a class="struct" href="struct.Window.html" title="struct futures::io::Window">Window</a><T><span class="where fmt-newline">where<br> T: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-Window%3CT%3E" class="impl has-srclink"><a href="#impl-Send-for-Window%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Send for <a class="struct" href="struct.Window.html" title="struct futures::io::Window">Window</a><T><span class="where fmt-newline">where<br> T: Send,</span></h3></section><section id="impl-Sync-for-Window%3CT%3E" class="impl has-srclink"><a href="#impl-Sync-for-Window%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Sync for <a class="struct" href="struct.Window.html" title="struct futures::io::Window">Window</a><T><span class="where fmt-newline">where<br> T: Sync,</span></h3></section><section id="impl-Unpin-for-Window%3CT%3E" class="impl has-srclink"><a href="#impl-Unpin-for-Window%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Unpin for <a class="struct" href="struct.Window.html" title="struct futures::io::Window">Window</a><T><span class="where fmt-newline">where<br> T: Unpin,</span></h3></section><section id="impl-UnwindSafe-for-Window%3CT%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Window%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> UnwindSafe for <a class="struct" href="struct.Window.html" title="struct futures::io::Window">Window</a><T><span class="where fmt-newline">where<br> T: UnwindSafe,</span></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-Window%3CT%3E" class="impl has-srclink"><a href="#impl-Any-for-Window%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Window%3CT%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Window%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Window%3CT%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Window%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Window%3CT%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Window%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-Window%3CT%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Window%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-Window%3CT%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-Window%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Window%3CT%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Window%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="futures" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
