<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="API documentation for the Rust `PipeRingBuffer` struct in crate `os`."><title>PipeRingBuffer in os::fs::pipe - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../../../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../../../static.files/rustdoc-4e54bb2b497cc83f.css"><metaname="rustdoc-vars"data-root-path="../../../"data-static-root-path="../../../static.files/"data-current-crate="os"data-themes=""data-resource-suffix=""data-rustdoc-version="1.77.0-nightly (6ae4cfbbb 2024-01-17)"data-channel="nightly"data-search-js="search-dd67cee4cfa65049.js"data-settings-js="settings-4313503d2e1961c2.js"><scriptsrc="../../../static.files/storage-f2adc0d6ca4d09fb.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../../../static.files/main-0b2e2def73e61cbe.js"></script><noscript><linkrel="stylesheet"href="../../../static.files/noscript-04d5337699b92874.css"></noscript><linkrel="alternate icon"type="image/png"href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../../../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle"title="show sidebar"></button></nav><navclass="sidebar"><divclass="sidebar-crate"><h2><ahref="../../../os/index.html">os</a><spanclass="version">0.1.0</span></h2></div><h2class="location"><ahref="#">PipeRingBuffer</a></h2><divclass="sidebar-elems"><section><h3><ahref="#fields">Fields</a></h3><ulclass="block structfield"><li><ahref="#structfield.arr">arr</a></li><li><ahref="#structfield.head">head</a></li><li><ahref="#structfield.status">status</a></li><li><ahref="#structfield.tail">tail</a></li><li><ahref="#structfield.write_end">write_end</a></li></ul><h3><ahref="#implementations">Methods</a></h3><ulclass="block method"><li><ahref="#method.all_write_ends_closed">all_write_ends_closed</a></li><li><ahref="#method.available_read">available_read</a></li><li><ahref="#method.available_write">available_write</a></li><li><ahref="#method.new">new</a></li><li><ahref="#method.read_byte">read_byte</a></li><li><ahref="#method.set_write_end">set_write_end</a></li><li><ahref="#method.write_byte">write_byte</a></li></ul><h3><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><ulclass="block synthetic-implementation"><li><ahref="#impl-RefUnwindSafe-for-PipeRingBuffer">!RefUnwindSafe</a></li><li><ahref="#impl-UnwindSafe-for-PipeRingBuffer">!UnwindSafe</a></li><li><ahref="#impl-Send-for-PipeRingBuffer">Send</a></li><li><ahref="#impl-Sync-for-PipeRingBuffer">Sync</a></li><li><ahref="#impl-Unpin-for-PipeRingBuffer">Unpin</a></li></ul><h3><ahref="#blanket-implementations">Blanket Implementations</a></h3><ulclass="block blanket-implementation"><li><ahref="#impl-Any-for-T">Any</a></li><li><ahref="#impl-Az-for-T">Az</a></li><li><ahref="#impl-Borrow%3CT%3E-for-T">Borrow<T></a></li><li><a
<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../../../os/all.html"title="show sidebar"></a></div><inputclass="search-input"name="search"aria-label="Run search in the documentation"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><divid="help-button"tabindex="-1"><ahref="../../../help.html"title="help">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Struct <ahref="../../index.html">os</a>::<wbr><ahref="../index.html">fs</a>::<wbr><ahref="index.html">pipe</a>::<wbr><aclass="struct"href="#">PipeRingBuffer</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../../../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../../../src/os/fs/pipe.rs.html#40-46">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code>pub struct PipeRingBuffer {
T: 'static + ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.type_id"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#141">source</a><ahref="#method.type_id"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id"class="fn">type_id</a>(&self) -><aclass="struct"href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html"title="struct core::any::TypeId">TypeId</a></h4></section></summary><divclass='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <ahref="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-Az-for-T"class="impl"><aclass="src rightside"href="https://docs.rs/az/~1.2/src/az/lib.rs.html#599">source</a><ahref="#impl-Az-for-T"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://docs.rs/az/~1.2/az/trait.Az.html"title="trait az::Az">Az</a> for T</h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.az"class="method trait-impl"><aclass="src rightside"href="https://docs.rs/az/~1.2/src/az/lib.rs.html#602-604">source</a><ahref="#method.az"class="anchor">§</a><h4class="code-header">fn <ahref="https://docs.rs/az/~1.2/az/trait.Az.html#tymethod.az"class="fn">az</a><Dst>(self) -> Dst<divclass="where">where
T: <aclass="trait"href="https://docs.rs/az/~1.2/az/trait.Cast.html"title="trait az::Cast">Cast</a><Dst>,</div></h4></section></summary><divclass='docblock'>Casts the value.</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-Borrow%3CT%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#208">source</a><ahref="#impl-Borrow%3CT%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html"title="trait core::borrow::Borrow">Borrow</a><T> for T<divclass="where">where
T: ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.borrow"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#210">source</a><ahref="#method.borrow"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow"class="fn">borrow</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/core/primitive.reference.html">&T</a></h4></section></summary><divclass='docblock'>Immutably borrows from an owned value. <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-BorrowMut%3CT%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#216">source</a><ahref="#impl-BorrowMut%3CT%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html"title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<divclass="where">where
T: ?<aclass="trait"href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.borrow_mut"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#217">source</a><ahref="#method.borrow_mut"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut"class="fn">borrow_mut</a>(&mut self) -><aclass="primitive"href="https://doc.rust-lang.org/nightly/core/primitive.reference.html">&mut T</a></h4></section></summary><divclass='docblock'>Mutably borrows from an owned value. <ahref="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-CastFrom%3CSrc%3E-for-Dst"class="impl"><aclass="src rightside"href="https://docs.rs/az/~1.2/src/az/lib.rs.html#330">source</a><ahref="#impl-CastFrom%3CSrc%3E-for-Dst"class="anchor">§</a><h3class="code-header">impl<Src, Dst><aclass="trait"href="https://docs.rs/az/~1.2/az/trait.CastFrom.html"title="trait az::CastFrom">CastFrom</a><Src> for Dst<divclass="where">where
<code><ahref="https://doc.rust-lang.org/nightly/core/convert/trait.From.html"title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
T: <aclass="trait"href="https://docs.rs/az/~1.2/az/trait.SaturatingCast.html"title="trait az::SaturatingCast">SaturatingCast</a><Dst>,</div></h4></section></summary><divclass='docblock'>Casts the value.</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-SaturatingCastFrom%3CSrc%3E-for-Dst"class="impl"><aclass="src rightside"href="https://docs.rs/az/~1.2/src/az/lib.rs.html#402">source</a><ahref="#impl-SaturatingCastFrom%3CSrc%3E-for-Dst"class="anchor">§</a><h3class="code-header">impl<Src, Dst><aclass="trait"href="https://docs.rs/az/~1.2/az/trait.SaturatingCastFrom.html"title="trait az::SaturatingCastFrom">SaturatingCastFrom</a><Src> for Dst<divclass="where">where
Src: <aclass="trait"href="https://docs.rs/az/~1.2/az/trait.SaturatingCast.html"title="trait az::SaturatingCast">SaturatingCast</a><Dst>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.saturating_cast_from"class="method trait-impl"><aclass="src rightside"href="https://docs.rs/az/~1.2/src/az/lib.rs.html#405">source</a><ahref="#method.saturating_cast_from"class="anchor">§</a><h4class="code-header">fn <ahref="https://docs.rs/az/~1.2/az/trait.SaturatingCastFrom.html#tymethod.saturating_cast_from"class="fn">saturating_cast_from</a>(src: Src) -> Dst</h4></section></summary><divclass='docblock'>Casts the value.</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryFrom%3CU%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#803-805">source</a><ahref="#impl-TryFrom%3CU%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T<divclass="where">where
U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error-1"class="associatedtype trait-impl"><ahref="#associatedtype.Error-1"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4></section></summary><divclass='docblock'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_from"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#810">source</a><ahref="#method.try_from"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from"class="fn">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="associatedtype"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'>Performs the conversion.</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryInto%3CU%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#788-790">source</a><ahref="#impl-TryInto%3CU%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T<divclass="where">where
U: <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error"class="associatedtype trait-impl"><ahref="#associatedtype.Error"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><divclass='docblock'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_into"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#795">source</a><ahref="#method.try_into"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into"class="fn">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'>Performs the conversion.</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-UnwrappedAs-for-T"class="impl"><aclass="src rightside"href="https://docs.rs/az/~1.2/src/az/lib.rs.html#977">source</a><ahref="#impl-UnwrappedAs-for-T"class="anchor">§</a><h3class="code-header">impl<T><aclass="trait"href="https://docs.rs/az/~1.2/az/trait.UnwrappedAs.html"title="trait az::UnwrappedAs">UnwrappedAs</a> for T</h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.unwrapped_as"class="method trait-impl"><aclass="src rightside"href="https://docs.rs/az/~1.2/src/az/lib.rs.html#979-981">source</a><ahref="#method.unwrapped_as"class="anchor">§</a><h4class="code-header">fn <ahref="https://docs.rs/az/~1.2/az/trait.UnwrappedAs.html#tymethod.unwrapped_as"class="fn">unwrapped_as</a><Dst>(self) -> Dst<divclass="where">where
T: <aclass="trait"href="https://docs.rs/az/~1.2/az/trait.UnwrappedCast.html"title="trait az::UnwrappedCast">UnwrappedCast</a><Dst>,</div></h4></section></summary><divclass='docblock'>Casts the value.</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-UnwrappedCastFrom%3CSrc%3E-for-Dst"class="impl"><aclass="src rightside"href="https://docs.rs/az/~1.2/src/az/lib.rs.html#526">source</a><ahref="#impl-UnwrappedCastFrom%3CSrc%3E-for-Dst"class="anchor">§</a><h3class="code-header">impl<Src, Dst><aclass="trait"href="https://docs.rs/az/~1.2/az/trait.UnwrappedCastFrom.html"title="trait az::UnwrappedCastFrom">UnwrappedCastFrom</a><Src> for Dst<divclass="where">where
