pub trait Seek {
// Required method
fn seek(&mut self, pos: SeekFrom) -> Result<u64, IoError>;
// Provided methods
fn rewind(&mut self) -> Result<(), IoError> { ... }
fn stream_position(&mut self) -> Result<u64, IoError> { ... }
fn stream_len(&mut self) -> Result<u64, IoError> { ... }
fn seek_relative(&mut self, offset: i64) -> Result<(), IoError> { ... }
}Expand description
The Seek trait provides a cursor which can be moved within a stream of
bytes.
See [std::io::Seek] for more details.
Required Methods§
Sourcefn seek(&mut self, pos: SeekFrom) -> Result<u64, IoError>
fn seek(&mut self, pos: SeekFrom) -> Result<u64, IoError>
Seek to an offset, in bytes, in a stream.
A seek beyond the end of a stream is allowed, but behavior is defined by the implementation.
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 SeekFrom::Start.
Provided Methods§
Sourcefn rewind(&mut self) -> Result<(), IoError>
fn rewind(&mut self) -> Result<(), IoError>
Rewind to the beginning of a stream.
This is a convenience method, equivalent to seek(SeekFrom::Start(0)).
Sourcefn stream_position(&mut self) -> Result<u64, IoError>
fn stream_position(&mut self) -> Result<u64, IoError>
Returns the current seek position from the start of the stream.
This is equivalent to self.seek(SeekFrom::Current(0)).
Sourcefn stream_len(&mut self) -> Result<u64, IoError>
fn stream_len(&mut self) -> Result<u64, IoError>
Returns the length of this stream (in bytes).
Dyn Compatibility§
This trait is dyn compatible.
In older versions of Rust, dyn compatibility was called "object safety".