Struct unix::file::File

pub struct File { /* fields omitted */ }

File descriptor, closed on drop

Implementations

impl File

pub fn chmod(&self, mode: Mode) -> Result<(), Error>

Change the mode of the file.

pub fn stat(&self) -> Result<Stat, Error>

Return information about the file.

pub fn sync(&self, metadata: bool) -> Result<(), Error>

Flush all cached modifications of the file to the device. If metadata, also flush modifications of the metadata.

pub fn truncate(&self, length: u64) -> Result<(), Error>

Truncate the file to the given length.

pub fn exec(&self, argv: &Nul<&Str>, envp: &Nul<&Str>) -> Result<Void, Error>

Execute the program file.

The current program of the calling process is replaced with the new one, with a fresh stack, heap, and data segment. argv is an array of argument strings to pass to the new program. By convention, the first should be the name of the program file. env is an array of strings, conventionally of form "key=value", which are passed as the environment.

pub fn fd(&self) -> isize

Return the file descriptor of the File.

pub fn new(fd: isize) -> Option<Self>

Make a File of a file descriptor, which is checked for validity.

pub const fn new_unchecked(fd: isize) -> Self

Make a File of a file descriptor, which is not checked.

Trait Implementations

impl Debug for File

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

Formats the value using the given formatter.

impl Drop for File

pub fn drop(&mut self)

Executes the destructor for this type.

impl MapExt for File

type MapSpec = Option<Segment>

Specifier of which part of value to map

pub fn map(&self, perm: Perm, seg: Option<Segment>) -> Result<Map, Error>

Map the value into memory at an unspecified location.

pub unsafe fn map_at(
    &self,
    loc: *mut u8,
    perm: Perm,
    seg: Option<Segment>
) -> Result<Map, Error>

Map the value into memory at the given location.

impl Read<u8> for File

type Err = Error

pub fn readv(&mut self, bufs: &mut [&mut [u8]]) -> Result<usize, Self::Err>

Pull some data, at most bufs.fold(0, |n, buf| n+buf.len()), from this source into given buffers; return how many data were actually read, or a failure. May block if no data can be read when called.

pub fn read(&mut self, buf: &mut [T]) -> Result<usize, Self::Err>

r.read(buf) = self.readv(&mut [buf])

pub fn try_read_full(
    &mut self,
    buf: &mut [T]
) -> Result<usize, (Self::Err, usize)>

Pull buf.len() data from this source into given buffer; return how many data were actually read (which may be less than buf.len() if we reached end-of-file), or a failure and how many data were read before the failure.

pub fn read_full<E>(&mut self, buf: &mut [T]) -> Result<(), (E, usize)> where
    E: From<Self::Err> + From<EndOfFile>, 

Pull buf.len() data from this source into given buffer; return () if so many data were actually read, or a failure and how many data were read before the failure.

pub fn size_hint(&self) -> (usize, Option<usize>)

Return bounds on number of data ready to read.

pub fn data(self) -> Data<Self, T>

Make an Iterator over the data of this reader.

pub fn read_onto_vec<A>(
    &mut self,
    xs: &mut Vec<T, A>
) -> Result<usize, Self::Err> where
    A: Alloc, 

Pull data from this source into the spare storage of xs, and modify its length to include the data read. If this fails, xs is unmodified.

pub fn split<P, E>(self, p: P, keep_delim: bool) -> Split<Self, T, P, E> where
    E: From<Self::Err> + From<NoMemory>,
    P: FnMut(T) -> bool, 

impl TryClone for File

type Error = Error

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

pub fn try_clone_from(&mut self, other: &Self) -> Result<(), Error>

impl TryFrom<File> for Entries

type Error = Error

The type returned in the event of a conversion error.

pub fn try_from(file: File) -> Result<Self, Error>

Performs the conversion.

impl Write for File

pub fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

pub fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

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

Glue for usage of the write! macro with implementors of this trait.

impl Write<u8> for File

type Err = Error

pub fn writev(&mut self, bufs: &[&[u8]]) -> Result<usize, Self::Err>

Push some data, at most bufs.fold(0, |n, buf| n+buf.len()), to this sink from given buffers; return how many data were actually written, or a failure. May block if no data can be written when called.

pub fn flush(&mut self) -> Result<(), Self::Err>

pub fn write(&mut self, buf: &[T]) -> Result<usize, Self::Err>

w.write(buf) = self.writev(&[buf])

pub fn write_all(&mut self, buf: &[T]) -> Result<(), (Self::Err, usize)> where
    Self::Err: From<EndOfFile>, 

Push buf.len() data to this sink from given buffer; return () if so many data were actually written, or a failure and how many data were written before the failure.

pub fn write_all_e(
    &mut self,
    buf: &[T]
) -> Result<(), (Either<EndOfFile, Self::Err>, usize)>

Push buf.len() data to this sink from given buffer; return () if so many data were actually written, or a failure and how many data were written before the failure.