Enum rustix::fs::SeekFrom

source ·
pub enum SeekFrom {
    Start(u64),
    End(i64),
    Current(i64),
    Data(i64),
    Hole(i64),
}
Expand description

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§

source§

impl Clone for SeekFrom

source§

fn clone(&self) -> SeekFrom

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for SeekFrom

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq for SeekFrom

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for SeekFrom

source§

impl Eq for SeekFrom

source§

impl StructuralEq for SeekFrom

source§

impl StructuralPartialEq for SeekFrom

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.