Enum FileNode

pub enum FileNode<T> {
    Regular {
        size: u64,
        executable: bool,
    },
    Symlink {
        target: ByteBuf,
    },
    Directory {
        size: u64,
        contents: T,
    },
}

This enum represents a single node in a file tree.

The type is generic over the contents of a directory node, because we want to use this enum to represent both a flat structure where a directory only stores some meta-information about itself (such as the number of children) and full file trees, where a directory contains all the child nodes.

Note that file nodes by themselves do not have names. Names are given to file nodes by the parent directory, which has a map of entry names to file nodes.

Variants

Regular

A regular file. This is the normal kind of file which is neither a directory not a symlink.

Fields

size: u64

The size of this file, in bytes.

executable: bool

Whether or not this file has the executable bit set.

Symlink

A symbolic link that points to another file path.

Fields

target: ByteBuf

The path that this symlink points to.

Directory

A directory. It usually has a mapping of names to child nodes (in the case of a fill tree), but we also support a reduced form where we only store the number of entries in the directory.

Fields

size: u64

The size of a directory is the number of children it contains.

contents: T

The contents of this directory. These are generic, as explained in the documentation for this type.

Implementations

impl<T> FileNode<T>

pub fn split_contents(&self) -> (FileNode<()>, Option<&T>)

Split this node into a node without contents and optionally the contents themselves, if the node was a directory.

pub fn get_type(&self) -> FileType

Return the type of this file.

impl FileNode<()>

pub fn decode(buf: &[u8]) -> Option<Self>

Trait Implementations

impl<T: Clone> Clone for FileNode<T>

fn clone(&self) -> FileNode<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for FileNode<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for FileNode<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq> PartialEq for FileNode<T>

fn eq(&self, other: &FileNode<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Serialize for FileNode<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for FileNode<T>