mirror of
https://github.com/NotAShelf/mpvrc.git
synced 2026-04-17 00:13:48 +00:00
76 lines
No EOL
26 KiB
HTML
76 lines
No EOL
26 KiB
HTML
<!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="Seek bytes asynchronously."><title>AsyncSeek in tokio::io - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="tokio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../tokio/index.html">tokio</a><span class="version">1.42.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Async<wbr>Seek</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.poll_complete" title="poll_complete">poll_complete</a></li><li><a href="#tymethod.start_seek" title="start_seek">start_seek</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-AsyncSeek-for-%26mut+T" title="&mut T">&mut T</a></li><li><a href="#impl-AsyncSeek-for-Box%3CT%3E" title="Box<T>">Box<T></a></li><li><a href="#impl-AsyncSeek-for-Cursor%3CT%3E" title="Cursor<T>">Cursor<T></a></li><li><a href="#impl-AsyncSeek-for-Pin%3CP%3E" title="Pin<P>">Pin<P></a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In tokio::<wbr>io</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">tokio</a>::<wbr><a href="index.html">io</a></span><h1>Trait <span class="trait">AsyncSeek</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/tokio/io/async_seek.rs.html#18-47">Source</a> </span></div><pre class="rust item-decl"><code>pub trait AsyncSeek {
|
||
// Required methods
|
||
fn <a href="#tymethod.start_seek" class="fn">start_seek</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><&mut Self>, position: <a class="enum" href="https://doc.rust-lang.org/1.84.1/std/io/enum.SeekFrom.html" title="enum std::io::SeekFrom">SeekFrom</a>) -> <a class="type" href="https://doc.rust-lang.org/1.84.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.unit.html">()</a>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.poll_complete" class="fn">poll_complete</a>(
|
||
self: <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><&mut Self>,
|
||
cx: &mut <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>,
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="type" href="https://doc.rust-lang.org/1.84.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u64.html">u64</a>>>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Seek bytes asynchronously.</p>
|
||
<p>This trait is analogous to the <a href="https://doc.rust-lang.org/1.84.1/std/io/trait.Seek.html" title="trait std::io::Seek"><code>std::io::Seek</code></a> trait, but integrates
|
||
with the asynchronous task system. In particular, the <code>start_seek</code>
|
||
method, unlike <a href="https://doc.rust-lang.org/1.84.1/std/io/trait.Seek.html#tymethod.seek" title="method std::io::Seek::seek"><code>Seek::seek</code></a>, will not block the calling thread.</p>
|
||
<p>Utilities for working with <code>AsyncSeek</code> values are provided by
|
||
<a href="trait.AsyncSeekExt.html" title="trait tokio::io::AsyncSeekExt"><code>AsyncSeekExt</code></a>.</p>
|
||
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.start_seek" class="method"><a class="src rightside" href="../../src/tokio/io/async_seek.rs.html#33">Source</a><h4 class="code-header">fn <a href="#tymethod.start_seek" class="fn">start_seek</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><&mut Self>, position: <a class="enum" href="https://doc.rust-lang.org/1.84.1/std/io/enum.SeekFrom.html" title="enum std::io::SeekFrom">SeekFrom</a>) -> <a class="type" href="https://doc.rust-lang.org/1.84.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Attempts to seek to an offset, in bytes, in a stream.</p>
|
||
<p>A seek beyond the end of a stream is allowed, but behavior is defined
|
||
by the implementation.</p>
|
||
<p>If this function returns successfully, then the job has been submitted.
|
||
To find out when it completes, call <code>poll_complete</code>.</p>
|
||
<h5 id="errors"><a class="doc-anchor" href="#errors">§</a>Errors</h5>
|
||
<p>This function can return <a href="https://doc.rust-lang.org/1.84.1/std/io/error/enum.ErrorKind.html#variant.Other" title="variant std::io::error::ErrorKind::Other"><code>io::ErrorKind::Other</code></a> in case there is
|
||
another seek in progress. To avoid this, it is advisable that any call
|
||
to <code>start_seek</code> is preceded by a call to <code>poll_complete</code> to ensure all
|
||
pending seeks have completed.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.poll_complete" class="method"><a class="src rightside" href="../../src/tokio/io/async_seek.rs.html#46">Source</a><h4 class="code-header">fn <a href="#tymethod.poll_complete" class="fn">poll_complete</a>(
|
||
self: <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><&mut Self>,
|
||
cx: &mut <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>,
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="type" href="https://doc.rust-lang.org/1.84.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u64.html">u64</a>>></h4></section></summary><div class="docblock"><p>Waits for a seek operation to complete.</p>
|
||
<p>If the seek operation completed successfully,
|
||
this method returns the new position from the start of the stream.
|
||
That position can be used later with <a href="https://doc.rust-lang.org/1.84.1/std/io/enum.SeekFrom.html#variant.Start" title="variant std::io::SeekFrom::Start"><code>SeekFrom::Start</code></a>. Repeatedly
|
||
calling this function without calling <code>start_seek</code> might return the
|
||
same result.</p>
|
||
<h5 id="errors-1"><a class="doc-anchor" href="#errors-1">§</a>Errors</h5>
|
||
<p>Seeking to a negative offset is considered an error.</p>
|
||
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-AsyncSeek-for-Pin%3CP%3E" class="impl"><a class="src rightside" href="../../src/tokio/io/async_seek.rs.html#69-81">Source</a><a href="#impl-AsyncSeek-for-Pin%3CP%3E" class="anchor">§</a><h3 class="code-header">impl<P> <a class="trait" href="trait.AsyncSeek.html" title="trait tokio::io::AsyncSeek">AsyncSeek</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><P><div class="where">where
|
||
P: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/ops/deref/trait.DerefMut.html" title="trait core::ops::deref::DerefMut">DerefMut</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
|
||
P::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.1/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a>: <a class="trait" href="trait.AsyncSeek.html" title="trait tokio::io::AsyncSeek">AsyncSeek</a>,</div></h3></section></summary><div class="impl-items"><section id="method.start_seek" class="method trait-impl"><a class="src rightside" href="../../src/tokio/io/async_seek.rs.html#74-76">Source</a><a href="#method.start_seek" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.start_seek" class="fn">start_seek</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><&mut Self>, pos: <a class="enum" href="https://doc.rust-lang.org/1.84.1/std/io/enum.SeekFrom.html" title="enum std::io::SeekFrom">SeekFrom</a>) -> <a class="type" href="https://doc.rust-lang.org/1.84.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.unit.html">()</a>></h4></section><section id="method.poll_complete" class="method trait-impl"><a class="src rightside" href="../../src/tokio/io/async_seek.rs.html#78-80">Source</a><a href="#method.poll_complete" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.poll_complete" class="fn">poll_complete</a>(
|
||
self: <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><&mut Self>,
|
||
cx: &mut <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>,
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="type" href="https://doc.rust-lang.org/1.84.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u64.html">u64</a>>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-AsyncSeek-for-Cursor%3CT%3E" class="impl"><a class="src rightside" href="../../src/tokio/io/async_seek.rs.html#83-90">Source</a><a href="#impl-AsyncSeek-for-Cursor%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><[<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u8.html">u8</a>]> + <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>> <a class="trait" href="trait.AsyncSeek.html" title="trait tokio::io::AsyncSeek">AsyncSeek</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.1/std/io/cursor/struct.Cursor.html" title="struct std::io::cursor::Cursor">Cursor</a><T></h3></section></summary><div class="impl-items"><section id="method.start_seek-1" class="method trait-impl"><a class="src rightside" href="../../src/tokio/io/async_seek.rs.html#84-86">Source</a><a href="#method.start_seek-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.start_seek" class="fn">start_seek</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><&mut Self>, pos: <a class="enum" href="https://doc.rust-lang.org/1.84.1/std/io/enum.SeekFrom.html" title="enum std::io::SeekFrom">SeekFrom</a>) -> <a class="type" href="https://doc.rust-lang.org/1.84.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.unit.html">()</a>></h4></section><section id="method.poll_complete-1" class="method trait-impl"><a class="src rightside" href="../../src/tokio/io/async_seek.rs.html#87-89">Source</a><a href="#method.poll_complete-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.poll_complete" class="fn">poll_complete</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><&mut Self>, _: &mut <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="type" href="https://doc.rust-lang.org/1.84.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u64.html">u64</a>>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-AsyncSeek-for-%26mut+T" class="impl"><a class="src rightside" href="../../src/tokio/io/async_seek.rs.html#65-67">Source</a><a href="#impl-AsyncSeek-for-%26mut+T" class="anchor">§</a><h3 class="code-header">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="trait.AsyncSeek.html" title="trait tokio::io::AsyncSeek">AsyncSeek</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>> <a class="trait" href="trait.AsyncSeek.html" title="trait tokio::io::AsyncSeek">AsyncSeek</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.reference.html">&mut T</a></h3></section></summary><div class="impl-items"><section id="method.start_seek-2" class="method trait-impl"><a class="src rightside" href="../../src/tokio/io/async_seek.rs.html#66">Source</a><a href="#method.start_seek-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.start_seek" class="fn">start_seek</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><&mut Self>, pos: <a class="enum" href="https://doc.rust-lang.org/1.84.1/std/io/enum.SeekFrom.html" title="enum std::io::SeekFrom">SeekFrom</a>) -> <a class="type" href="https://doc.rust-lang.org/1.84.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.unit.html">()</a>></h4></section><section id="method.poll_complete-2" class="method trait-impl"><a class="src rightside" href="../../src/tokio/io/async_seek.rs.html#66">Source</a><a href="#method.poll_complete-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.poll_complete" class="fn">poll_complete</a>(
|
||
self: <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><&mut Self>,
|
||
cx: &mut <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>,
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="type" href="https://doc.rust-lang.org/1.84.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u64.html">u64</a>>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-AsyncSeek-for-Box%3CT%3E" class="impl"><a class="src rightside" href="../../src/tokio/io/async_seek.rs.html#61-63">Source</a><a href="#impl-AsyncSeek-for-Box%3CT%3E" class="anchor">§</a><h3 class="code-header">impl<T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="trait.AsyncSeek.html" title="trait tokio::io::AsyncSeek">AsyncSeek</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>> <a class="trait" href="trait.AsyncSeek.html" title="trait tokio::io::AsyncSeek">AsyncSeek</a> for <a class="struct" href="https://doc.rust-lang.org/1.84.1/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T></h3></section></summary><div class="impl-items"><section id="method.start_seek-3" class="method trait-impl"><a class="src rightside" href="../../src/tokio/io/async_seek.rs.html#62">Source</a><a href="#method.start_seek-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.start_seek" class="fn">start_seek</a>(self: <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><&mut Self>, pos: <a class="enum" href="https://doc.rust-lang.org/1.84.1/std/io/enum.SeekFrom.html" title="enum std::io::SeekFrom">SeekFrom</a>) -> <a class="type" href="https://doc.rust-lang.org/1.84.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.unit.html">()</a>></h4></section><section id="method.poll_complete-3" class="method trait-impl"><a class="src rightside" href="../../src/tokio/io/async_seek.rs.html#62">Source</a><a href="#method.poll_complete-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.poll_complete" class="fn">poll_complete</a>(
|
||
self: <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><&mut Self>,
|
||
cx: &mut <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>,
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><<a class="type" href="https://doc.rust-lang.org/1.84.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u64.html">u64</a>>></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-AsyncSeek-for-File" class="impl"><a class="src rightside" href="../../src/tokio/fs/file.rs.html#651-713">Source</a><a href="#impl-AsyncSeek-for-File" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AsyncSeek.html" title="trait tokio::io::AsyncSeek">AsyncSeek</a> for <a class="struct" href="../fs/struct.File.html" title="struct tokio::fs::File">File</a></h3></section><section id="impl-AsyncSeek-for-Empty" class="impl"><a class="src rightside" href="../../src/tokio/io/util/empty.rs.html#136-148">Source</a><a href="#impl-AsyncSeek-for-Empty" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.AsyncSeek.html" title="trait tokio::io::AsyncSeek">AsyncSeek</a> for <a class="struct" href="struct.Empty.html" title="struct tokio::io::Empty">Empty</a></h3></section><section id="impl-AsyncSeek-for-BufReader%3CR%3E" class="impl"><a class="src rightside" href="../../src/tokio/io/util/buf_reader.rs.html#176-259">Source</a><a href="#impl-AsyncSeek-for-BufReader%3CR%3E" class="anchor">§</a><h3 class="code-header">impl<R: <a class="trait" href="trait.AsyncRead.html" title="trait tokio::io::AsyncRead">AsyncRead</a> + <a class="trait" href="trait.AsyncSeek.html" title="trait tokio::io::AsyncSeek">AsyncSeek</a>> <a class="trait" href="trait.AsyncSeek.html" title="trait tokio::io::AsyncSeek">AsyncSeek</a> for <a class="struct" href="struct.BufReader.html" title="struct tokio::io::BufReader">BufReader</a><R></h3></section><div class="docblock"><p>Seeks to an offset, in bytes, in the underlying reader.</p>
|
||
<p>The position used for seeking with <code>SeekFrom::Current(_)</code> is the
|
||
position the underlying reader would be at if the <code>BufReader</code> had no
|
||
internal buffer.</p>
|
||
<p>Seeking always discards the internal buffer, even if the seek position
|
||
would otherwise fall within it. This guarantees that calling
|
||
<code>.into_inner()</code> immediately after a seek yields the underlying reader
|
||
at the same position.</p>
|
||
<p>See <a href="trait.AsyncSeek.html" title="trait tokio::io::AsyncSeek"><code>AsyncSeek</code></a> for more details.</p>
|
||
<p>Note: In the edge case where you’re seeking with <code>SeekFrom::Current(n)</code>
|
||
where <code>n</code> minus the internal buffer length overflows an <code>i64</code>, two
|
||
seeks will be performed instead of one. If the second seek returns
|
||
<code>Err</code>, the underlying reader will be left at the same position it would
|
||
have if you called <code>seek</code> with <code>SeekFrom::Current(0)</code>.</p>
|
||
</div><section id="impl-AsyncSeek-for-BufStream%3CRW%3E" class="impl"><a class="src rightside" href="../../src/tokio/io/util/buf_stream.rs.html#179-187">Source</a><a href="#impl-AsyncSeek-for-BufStream%3CRW%3E" class="anchor">§</a><h3 class="code-header">impl<RW: <a class="trait" href="trait.AsyncRead.html" title="trait tokio::io::AsyncRead">AsyncRead</a> + <a class="trait" href="trait.AsyncWrite.html" title="trait tokio::io::AsyncWrite">AsyncWrite</a> + <a class="trait" href="trait.AsyncSeek.html" title="trait tokio::io::AsyncSeek">AsyncSeek</a>> <a class="trait" href="trait.AsyncSeek.html" title="trait tokio::io::AsyncSeek">AsyncSeek</a> for <a class="struct" href="struct.BufStream.html" title="struct tokio::io::BufStream">BufStream</a><RW></h3></section><div class="docblock"><p>Seek to an offset, in bytes, in the underlying stream.</p>
|
||
<p>The position used for seeking with <code>SeekFrom::Current(_)</code> is the
|
||
position the underlying stream would be at if the <code>BufStream</code> had no
|
||
internal buffer.</p>
|
||
<p>Seeking always discards the internal buffer, even if the seek position
|
||
would otherwise fall within it. This guarantees that calling
|
||
<code>.into_inner()</code> immediately after a seek yields the underlying reader
|
||
at the same position.</p>
|
||
<p>See <a href="trait.AsyncSeek.html" title="trait tokio::io::AsyncSeek"><code>AsyncSeek</code></a> for more details.</p>
|
||
<p>Note: In the edge case where you’re seeking with <code>SeekFrom::Current(n)</code>
|
||
where <code>n</code> minus the internal buffer length overflows an <code>i64</code>, two
|
||
seeks will be performed instead of one. If the second seek returns
|
||
<code>Err</code>, the underlying reader will be left at the same position it would
|
||
have if you called <code>seek</code> with <code>SeekFrom::Current(0)</code>.</p>
|
||
</div><section id="impl-AsyncSeek-for-BufWriter%3CW%3E" class="impl"><a class="src rightside" href="../../src/tokio/io/util/buf_writer.rs.html#226-267">Source</a><a href="#impl-AsyncSeek-for-BufWriter%3CW%3E" class="anchor">§</a><h3 class="code-header">impl<W: <a class="trait" href="trait.AsyncWrite.html" title="trait tokio::io::AsyncWrite">AsyncWrite</a> + <a class="trait" href="trait.AsyncSeek.html" title="trait tokio::io::AsyncSeek">AsyncSeek</a>> <a class="trait" href="trait.AsyncSeek.html" title="trait tokio::io::AsyncSeek">AsyncSeek</a> for <a class="struct" href="struct.BufWriter.html" title="struct tokio::io::BufWriter">BufWriter</a><W></h3></section><div class="docblock"><p>Seek to the offset, in bytes, in the underlying writer.</p>
|
||
<p>Seeking always writes out the internal buffer before seeking.</p>
|
||
</div></div><script src="../../trait.impl/tokio/io/async_seek/trait.AsyncSeek.js" data-ignore-extern-crates="alloc,core,std" async></script></section></div></main></body></html> |