Enum VfFile 

#[non_exhaustive]
pub enum VfFile {
    Cwd,
    Descriptor(i32),
    Path {
        base: VfPathBase,
        path: PathBuf,
    },
    CwdPath(PathBuf),
    Saved,
}

A reference to a file: an open descriptor, a path, or a special pseudo-file. This is the Rust-native form of the C tc_file tagged struct (type + fd + path), where the variant is the tag.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Cwd

The client’s current working directory (a stat target, but not a file for read/write). Also the Default placeholder.

Descriptor(i32)

An open file descriptor (backend-assigned).

Path

A path; the VfPathBase records whether it is absolute or relative to the client’s cwd. Note that the raw path (see path) does not itself record the base; the filesystem resolves it while honoring this field.

Fields

base: VfPathBase

path: PathBuf

CwdPath(PathBuf)

A path relative to the client’s current working directory.

Saved

The saved (previous) directory, mirroring the C sentinel. No current backend produces or consumes this; operations on it fail.

Implementations

impl VfFile

pub fn from_path(path: &str) -> VfFile

pub fn from_path_bytes(path: &[u8]) -> VfFile

Construct from arbitrary Unix path bytes.

pub fn from_os_path(path: &Path) -> VfFile

Construct from a native Unix path.

pub fn from_fd(fd: i32) -> VfFile

pub fn cwd() -> VfFile

VF_FILE_CURRENT: the client’s current working directory itself.

pub fn cwd_path(path: impl Into<PathBuf>) -> VfFile

A path relative to the client’s current working directory.

pub fn saved() -> VfFile

pub fn is_descriptor(&self) -> bool

Whether this references an open descriptor.

pub fn fd(&self) -> Option<i32>

The open descriptor, if this is a Descriptor.

pub fn path(&self) -> Option<&Path>

The raw path, for Path and CwdPath. This does not resolve VfPathBase or the client working directory.

pub fn path_bytes(&self) -> Option<&[u8]>

The raw bytes of this path, if path-backed.

Trait Implementations

impl Clone for VfFile

fn clone(&self) -> VfFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VfFile

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

Formats the value using the given formatter.

impl Default for VfFile

fn default() -> VfFile

Returns the “default value” for a type.

impl Eq for VfFile

impl PartialEq for VfFile

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for VfFile