Enum Kind

pub enum Kind {
    File {
        handle: Option<Arc<RwLock<Box<dyn VirtualFile + Send + Sync + 'static>>>>,
        path: PathBuf,
        fd: Option<u32>,
    },
    Socket {
        socket: InodeSocket,
    },
    Pipe {
        pipe: Pipe,
    },
    Epoll {
        subscriptions: Arc<Mutex<HashMap<Fd, (EpollFd, Vec<EpollJoinGuard>)>>>,
        tx: Arc<Sender<EpollInterest>>,
        rx: Arc<Mutex<Receiver<EpollInterest>>>,
    },
    Dir {
        parent: InodeWeakGuard,
        path: PathBuf,
        entries: HashMap<String, InodeGuard>,
    },
    Root {
        entries: HashMap<String, InodeGuard>,
    },
    Symlink {
        base_po_dir: Fd,
        path_to_symlink: PathBuf,
        relative_path: PathBuf,
    },
    Buffer {
        buffer: Vec<u8>,
    },
    EventNotifications {
        inner: Arc<NotificationInner>,
    },
}

The core of the filesystem abstraction. Includes directories, files, and symlinks.

Variants

File

Fields

handle: Option<Arc<RwLock<Box<dyn VirtualFile + Send + Sync + 'static>>>>

The open file, if it’s open

path: PathBuf

The path on the host system where the file is located This is deprecated and will be removed soon

fd: Option<u32>

Marks the file as a special file that only one fd can exist for This is useful when dealing with host-provided special files that should be looked up by path TOOD: clarify here?

Socket

Fields

socket: InodeSocket

Represents a networking socket

Pipe

Fields

pipe: Pipe

Reference to the pipe

Epoll

Fields

subscriptions: Arc<Mutex<HashMap<Fd, (EpollFd, Vec<EpollJoinGuard>)>>>

tx: Arc<Sender<EpollInterest>>

rx: Arc<Mutex<Receiver<EpollInterest>>>

Dir

Fields

parent: InodeWeakGuard

Parent directory

path: PathBuf

The path on the host system where the directory is located

entries: HashMap<String, InodeGuard>

The entries of a directory are lazily filled.

Root

The same as Dir but without the irrelevant bits The root is immutable after creation; generally the Kind::Root branch of whatever code you’re writing will be a simpler version of your Kind::Dir logic

Fields

entries: HashMap<String, InodeGuard>

Symlink

The first two fields are data about the symlink the last field is the data inside the symlink

base_po_dir should never be the root because:

• Right now symlinks are not allowed in the immutable root
• There is always a closer pre-opened dir to the symlink file (by definition of the root being a collection of preopened dirs)

Fields

base_po_dir: Fd

The preopened dir that this symlink file is relative to (via path_to_symlink)

path_to_symlink: PathBuf

The path to the symlink from the base_po_dir

relative_path: PathBuf

the value of the symlink as a relative path

Buffer

Fields

buffer: Vec<u8>

EventNotifications

Fields

inner: Arc<NotificationInner>

Trait Implementations

impl Debug for Kind

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

Formats the value using the given formatter.