Struct cap_std::fs::File

source ·
pub struct File { /* private fields */ }
Expand description

A reference to an open file on a filesystem.

This corresponds to std::fs::File.

This File has no open or create methods. To open or create a file, first obtain a Dir containing the path, and then call Dir::open or Dir::create.

Implementations§

source§

impl File

source

pub fn from_std(std: File) -> Self

Constructs a new instance of Self from the given std::fs::File.

This grants access the resources the std::fs::File instance already has access to.

source

pub fn into_std(self) -> File

Consumes self and returns a std::fs::File.

source

pub fn sync_all(&self) -> Result<()>

Attempts to sync all OS-internal metadata to disk.

This corresponds to std::fs::File::sync_all.

source

pub fn sync_data(&self) -> Result<()>

This function is similar to sync_all, except that it may not synchronize file metadata to a filesystem.

This corresponds to std::fs::File::sync_data.

source

pub fn set_len(&self, size: u64) -> Result<()>

Truncates or extends the underlying file, updating the size of this file to become size.

This corresponds to std::fs::File::set_len.

source

pub fn metadata(&self) -> Result<Metadata>

Queries metadata about the underlying file.

This corresponds to std::fs::File::metadata.

source

pub fn try_clone(&self) -> Result<Self>

Creates a new File instance that shares the same underlying file handle as the existing File instance.

This corresponds to std::fs::File::try_clone.

source

pub fn set_permissions(&self, perm: Permissions) -> Result<()>

Changes the permissions on the underlying file.

This corresponds to std::fs::File::set_permissions.

source

pub fn open_ambient<P: AsRef<Path>>(
    path: P,
    ambient_authority: AmbientAuthority
) -> Result<Self>

Constructs a new instance of Self in read-only mode by opening the given path as a file using the host process’ ambient authority.

Ambient Authority

This function is not sandboxed and may access any path that the host process has access to.

source

pub fn open_ambient_with<P: AsRef<Path>>(
    path: P,
    options: &OpenOptions,
    ambient_authority: AmbientAuthority
) -> Result<Self>

Constructs a new instance of Self with the options specified by options by opening the given path as a file using the host process’ ambient authority.

Ambient Authority

This function is not sandboxed and may access any path that the host process has access to.

source

pub fn options() -> OpenOptions

Returns a new OpenOptions object.

This corresponds to std::fs::File::options.

Trait Implementations§

source§

impl AsFd for File

Available on non-Windows only.
source§

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor. Read more
source§

impl AsRawFd for File

Available on non-Windows only.
source§

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more
source§

impl Debug for File

source§

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

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

impl FileExt for File

Available on Unix only.
source§

fn read_at(&self, buf: &mut [u8], offset: u64) -> Result<usize>

Reads a number of bytes starting from a given offset. Read more
source§

fn write_at(&self, buf: &[u8], offset: u64) -> Result<usize>

Writes a number of bytes starting from a given offset. Read more
source§

fn read_exact_at(&self, buf: &mut [u8], offset: u64) -> Result<()>

Reads the exact number of byte required to fill buf from the given offset. Read more
source§

fn write_all_at(&self, buf: &[u8], offset: u64) -> Result<()>

Attempts to write an entire buffer starting from a given offset. Read more
source§

impl From<File> for OwnedFd

Available on non-Windows only.
source§

fn from(file: File) -> OwnedFd

Converts to this type from the input type.
source§

impl From<File> for Stdio

source§

fn from(file: File) -> Self

Converts to this type from the input type.
source§

impl From<OwnedFd> for File

Available on non-Windows only.
source§

fn from(fd: OwnedFd) -> Self

Converts to this type from the input type.
source§

impl FromRawFd for File

Available on non-Windows only.
source§

unsafe fn from_raw_fd(fd: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor. Read more
source§

impl IntoRawFd for File

Available on non-Windows only.
source§

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor. Read more
source§

impl Read for &File

source§

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
source§

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>

Like read, except that it reads into a slice of buffers. Read more
source§

fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>

Read the exact number of bytes required to fill buf. Read more
source§

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>

Read all bytes until EOF in this source, placing them into buf. Read more
source§

fn read_to_string(&mut self, buf: &mut String) -> Result<usize>

Read all bytes until EOF in this source, appending them to buf. Read more
source§

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Reader has an efficient read_vectored implementation. Read more
source§

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Pull some bytes from this source into the specified buffer. Read more
source§

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Read the exact number of bytes required to fill cursor. Read more
1.0.0 · source§

fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,

Creates a “by reference” adaptor for this instance of Read. Read more
1.0.0 · source§

fn bytes(self) -> Bytes<Self>where
    Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more
1.0.0 · source§

fn chain<R>(self, next: R) -> Chain<Self, R>where
    R: Read,
    Self: Sized,

Creates an adapter which will chain this stream with another. Read more
1.0.0 · source§

fn take(self, limit: u64) -> Take<Self>where
    Self: Sized,

Creates an adapter which will read at most limit bytes from it. Read more
source§

impl Read for File

source§

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
source§

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>

Like read, except that it reads into a slice of buffers. Read more
source§

fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>

Read the exact number of bytes required to fill buf. Read more
source§

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>

Read all bytes until EOF in this source, placing them into buf. Read more
source§

fn read_to_string(&mut self, buf: &mut String) -> Result<usize>

Read all bytes until EOF in this source, appending them to buf. Read more
source§

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Reader has an efficient read_vectored implementation. Read more
source§

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Pull some bytes from this source into the specified buffer. Read more
source§

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Read the exact number of bytes required to fill cursor. Read more
1.0.0 · source§

fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,

Creates a “by reference” adaptor for this instance of Read. Read more
1.0.0 · source§

fn bytes(self) -> Bytes<Self>where
    Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more
1.0.0 · source§

fn chain<R>(self, next: R) -> Chain<Self, R>where
    R: Read,
    Self: Sized,

Creates an adapter which will chain this stream with another. Read more
1.0.0 · source§

fn take(self, limit: u64) -> Take<Self>where
    Self: Sized,

Creates an adapter which will read at most limit bytes from it. Read more
source§

impl Seek for &File

source§

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream. Read more
source§

fn stream_position(&mut self) -> Result<u64>

Returns the current seek position from the start of the stream. Read more
1.55.0 · source§

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream. Read more
source§

fn stream_len(&mut self) -> Result<u64, Error>

🔬This is a nightly-only experimental API. (seek_stream_len)
Returns the length of this stream (in bytes). Read more
source§

impl Seek for File

source§

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream. Read more
source§

fn stream_position(&mut self) -> Result<u64>

Returns the current seek position from the start of the stream. Read more
1.55.0 · source§

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream. Read more
source§

fn stream_len(&mut self) -> Result<u64, Error>

🔬This is a nightly-only experimental API. (seek_stream_len)
Returns the length of this stream (in bytes). Read more
source§

impl Write for &File

source§

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written. Read more
source§

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
source§

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>

Like write, except that it writes from a slice of buffers. Read more
source§

fn write_all(&mut self, buf: &[u8]) -> Result<()>

Attempts to write an entire buffer into this writer. Read more
source§

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Writer has an efficient write_vectored implementation. Read more
source§

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<()>

🔬This is a nightly-only experimental API. (write_all_vectored)
Attempts to write multiple buffers into this writer. Read more
1.0.0 · source§

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · source§

fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,

Creates a “by reference” adapter for this instance of Write. Read more
source§

impl Write for File

source§

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written. Read more
source§

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
source§

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>

Like write, except that it writes from a slice of buffers. Read more
source§

fn write_all(&mut self, buf: &[u8]) -> Result<()>

Attempts to write an entire buffer into this writer. Read more
source§

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Writer has an efficient write_vectored implementation. Read more
source§

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<()>

🔬This is a nightly-only experimental API. (write_all_vectored)
Attempts to write multiple buffers into this writer. Read more
1.0.0 · source§

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · source§

fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,

Creates a “by reference” adapter for this instance of Write. Read more
source§

impl FilelikeViewType for File

Auto Trait Implementations§

§

impl RefUnwindSafe for File

§

impl Send for File

§

impl Sync for File

§

impl Unpin for File

§

impl UnwindSafe for File

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> AsFilelike for Twhere
    T: AsFd,

source§

fn as_filelike(&self) -> BorrowedFd<'_>

Borrows the reference. Read more
source§

fn as_filelike_view<Target>(&self) -> FilelikeView<'_, Target>where
    Target: FilelikeViewType,

Return a borrowing view of a resource which dereferences to a &Target. Read more
source§

impl<T> AsGrip for Twhere
    T: AsFd,

source§

fn as_grip(&self) -> BorrowedFd<'_>

Extracts the grip.
source§

impl<T> AsRawFilelike for Twhere
    T: AsRawFd,

source§

fn as_raw_filelike(&self) -> i32

Returns the raw value.
source§

impl<T> AsRawGrip for Twhere
    T: AsRawFd,

source§

fn as_raw_grip(&self) -> i32

Extracts the raw grip.
source§

impl<T> AsRawSocketlike for Twhere
    T: AsRawFd,

source§

fn as_raw_socketlike(&self) -> i32

Returns the raw value.
source§

impl<T> AsSocketlike for Twhere
    T: AsFd,

source§

fn as_socketlike(&self) -> BorrowedFd<'_>

Borrows the reference.
source§

fn as_socketlike_view<Target>(&self) -> SocketlikeView<'_, Target>where
    Target: SocketlikeViewType,

Return a borrowing view of a resource which dereferences to a &Target. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromFd for Twhere
    T: From<OwnedFd>,

source§

fn from_fd(owned_fd: OwnedFd) -> T

👎Deprecated since 1.0.0: FromFd::from_fd is replaced by From<OwnedFd>::from
Constructs a new instance of Self from the given file descriptor. Read more
source§

fn from_into_fd<Owned>(into_owned: Owned) -> Selfwhere
    Owned: Into<OwnedFd>,
    Self: Sized + From<OwnedFd>,

Constructs a new instance of Self from the given file descriptor converted from into_owned. Read more
source§

impl<T> FromFilelike for Twhere
    T: From<OwnedFd>,

source§

fn from_filelike(owned: OwnedFd) -> T

Constructs a new instance of Self from the given filelike object. Read more
source§

fn from_into_filelike<Owned>(owned: Owned) -> Twhere
    Owned: IntoFilelike,

Constructs a new instance of Self from the given filelike object converted from into_owned. Read more
source§

impl<T> FromGrip for Twhere
    T: From<OwnedFd>,

source§

fn from_grip(owned_grip: OwnedFd) -> T

Consume an OwnedGrip and convert into a Self.
source§

impl<T> FromRawFilelike for Twhere
    T: FromRawFd,

source§

unsafe fn from_raw_filelike(raw: i32) -> T

Constructs Self from the raw value. Read more
source§

impl<T> FromRawGrip for Twhere
    T: FromRawFd,

source§

unsafe fn from_raw_grip(raw_grip: i32) -> T

Consume an RawGrip and convert into a Self. Read more
source§

impl<T> FromRawSocketlike for Twhere
    T: FromRawFd,

source§

unsafe fn from_raw_socketlike(raw: i32) -> T

Constructs Self from the raw value. Read more
source§

impl<T> FromSocketlike for Twhere
    T: From<OwnedFd>,

source§

fn from_socketlike(owned: OwnedFd) -> T

Constructs a new instance of Self from the given socketlike object.
source§

fn from_into_socketlike<Owned>(owned: Owned) -> Twhere
    Owned: IntoSocketlike,

Constructs a new instance of Self from the given socketlike object converted from into_owned.
source§

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

const: unstable · 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> IntoFd for Twhere
    OwnedFd: From<T>,

source§

fn into_fd(self) -> OwnedFd

👎Deprecated since 1.0.0: IntoFd is replaced by From<...> for OwnedFd or Into<OwnedFd>
Consumes this object, returning the underlying file descriptor. Read more
source§

impl<T> IntoFilelike for Twhere
    T: Into<OwnedFd>,

source§

fn into_filelike(self) -> OwnedFd

Consumes this object, returning the underlying filelike object. Read more
source§

impl<T> IntoGrip for Twhere
    T: Into<OwnedFd>,

source§

fn into_grip(self) -> OwnedFd

Consume self and convert into an OwnedGrip.
source§

impl<T> IntoRawFilelike for Twhere
    T: IntoRawFd,

source§

fn into_raw_filelike(self) -> i32

Returns the raw value.
source§

impl<T> IntoRawGrip for Twhere
    T: IntoRawFd,

source§

fn into_raw_grip(self) -> i32

Consume self and convert into an RawGrip.
source§

impl<T> IntoRawSocketlike for Twhere
    T: IntoRawFd,

source§

fn into_raw_socketlike(self) -> i32

Returns the raw value.
source§

impl<T> IntoSocketlike for Twhere
    T: Into<OwnedFd>,

source§

fn into_socketlike(self) -> OwnedFd

Consumes this object, returning the underlying socketlike object.
§

impl<T> SetTimes for Twhere
    T: AsFilelike,

§

fn set_times(
    &self,
    atime: Option<SystemTimeSpec>,
    mtime: Option<SystemTimeSpec>
) -> Result<(), Error>

Set the last access and last modification timestamps of an open file handle. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.