Trait embedded_io::asynch::Seek

pub trait Seek: Io {
    type SeekFuture<'a>: Future<Output = Result<u64, Self::Error>>
    where
        Self: 'a;

    fn seek<'a>(&'a mut self, pos: SeekFrom) -> Self::SeekFuture<'a>;

    fn rewind<'a>(
        &'a mut self
    ) -> impl Future<Output = Result<(), Self::Error>> + 'a { ... }
    fn stream_position<'a>(&'a mut self) -> Self::SeekFuture<'a> { ... }
}

Available on crate feature async only.

Async seek within streams.

Semantics are the same as std::io::Seek, check its documentation for details.

Required Associated Types

type SeekFuture<'a>: Future<Output = Result<u64, Self::Error>>
where
    Self: 'a

Future returned by seek.

Required Methods

fn seek<'a>(&'a mut self, pos: SeekFrom) -> Self::SeekFuture<'a>

Seek to an offset, in bytes, in a stream.

Provided Methods

fn rewind<'a>(
    &'a mut self
) -> impl Future<Output = Result<(), Self::Error>> + 'a

Rewind to the beginning of a stream.

fn stream_position<'a>(&'a mut self) -> Self::SeekFuture<'a>

Returns the current seek position from the start of the stream.

Implementations on Foreign Types

impl<T: ?Sized + Seek> Seek for &mut T

type SeekFuture<'a>
where
    Self: 'a = impl Future<Output = Result<u64, <&mut T as Io>::Error>> + 'a

fn seek<'a>(&'a mut self, pos: SeekFrom) -> Self::SeekFuture<'a>

impl<T: ?Sized + Seek> Seek for Box<T>

Available on crate features std or alloc only.

type SeekFuture<'a>
where
    Self: 'a = impl Future<Output = Result<u64, <Box<T, Global> as Io>::Error>> + 'a

fn seek<'a>(&'a mut self, pos: SeekFrom) -> Self::SeekFuture<'a>

Implementors

impl<T: AsyncSeek + Unpin + ?Sized> Seek for FromTokio<T>

Available on crate feature tokio only.

type SeekFuture<'a>
where
    Self: 'a = impl Future<Output = Result<u64, <FromTokio<T> as Io>::Error>> + 'a

impl<T: AsyncSeek + Unpin + ?Sized> Seek for FromFutures<T>

Available on crate feature futures only.

type SeekFuture<'a>
where
    Self: 'a = impl Future<Output = Result<u64, <FromFutures<T> as Io>::Error>> + 'a