Struct OpenFile

pub struct OpenFile { /* private fields */ }

Represents a POSIX file description, or a Linux struct file.

An OpenFile wraps a reference to a File. Once there are no more OpenFile objects for a given File, the File will be closed. Typically this means that holding an OpenFile will ensure that the file remains open (the file’s status will not become FileState::CLOSED), but the underlying file may close itself in extenuating circumstances (for example if the file has an internal error).

Warning: If an OpenFile for a specific file already exists, it is an error to create a new OpenFile for that file. You must clone the existing OpenFile object. A new OpenFile object should probably only ever be created for a newly created file object. Otherwise for existing file objects, it won’t be clear if there are already-existing OpenFile objects for that file.

There must also not be any existing mutable borrows of the file when an OpenFile is created.

Implementations

impl OpenFile

pub fn new(file: File) -> Self

pub fn inner_file(&self) -> &File

pub fn close( self, cb_queue: &mut CallbackQueue, ) -> Option<Result<(), SyscallError>>

Will close the inner File object if this is the last OpenFile for that File. This behaviour is the same as simply dropping this OpenFile object, but allows you to pass an event queue and get the return value of the close operation.

Trait Implementations

impl Clone for OpenFile

fn clone(&self) -> OpenFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpenFile

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

Formats the value using the given formatter.

impl IsSend for OpenFile

impl IsSync for OpenFile