Enum rustix::fs::seek_from::SeekFrom

pub enum SeekFrom {
    Start(u64),
    End(i64),
    Current(i64),
    Data(i64),
    Hole(i64),
}

Enumeration of possible methods to seek within an I/O object.

It is used by the seek function.

This is similar to std::io::SeekFrom, however it adds platform-specific seek options.

Variants

Start(u64)

Sets the offset to the provided number of bytes.

End(i64)

Sets the offset to the size of this object plus the specified number of bytes.

It is possible to seek beyond the end of an object, but it’s an error to seek before byte 0.

Current(i64)

Sets the offset to the current position plus the specified number of bytes.

It is possible to seek beyond the end of an object, but it’s an error to seek before byte 0.

Data(i64)

Sets the offset to the current position plus the specified number of bytes, plus the distance to the next byte which is not in a hole.

If the offset is in a hole at the end of the file, the seek will fail with Errno::NXIO.

Hole(i64)

Sets the offset to the current position plus the specified number of bytes, plus the distance to the next byte which is in a hole.

If there is no hole past the offset, it will be set to the end of the file i.e. there is an implicit hole at the end of any file.

Trait Implementations

impl Clone for SeekFrom

fn clone(&self) -> SeekFrom

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SeekFrom

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SeekFrom

fn eq(&self, other: &SeekFrom) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SeekFrom

impl Eq for SeekFrom

impl StructuralPartialEq for SeekFrom