Struct Node

pub struct Node {
    pub name: String,
    pub node_type: NodeType,
    pub meta: Metadata,
    pub content: Option<Vec<DataId>>,
    pub subtree: Option<TreeId>,
}

A node within the tree hierarchy

Fields

name: String

Name of the node: filename or dirname.

Warning

This contains an escaped variant of the name in order to handle non-unicode filenames. Don’t access this field directly, use the Node::name() method instead!

node_type: NodeType

Information about node type

meta: Metadata

Node Metadata

content: Option<Vec<DataId>>

Contents of the Node

Note

This should be only set for regular files.

subtree: Option<TreeId>

Subtree of the Node.

Note

This should be only set for directories. (TODO: Check if this is correct)

Implementations

impl Node

pub const fn new( name: String, node_type: NodeType, meta: Metadata, content: Option<Vec<DataId>>, subtree: Option<TreeId>, ) -> Node

impl Node

pub fn new_node(name: &OsStr, node_type: NodeType, meta: Metadata) -> Self

Create a new Node with the given name, type and metadata

Arguments

• name - Name of the node
• node_type - Type of the node
• meta - Metadata of the node

Returns

The created Node

pub const fn is_dir(&self) -> bool

Evaluates if this node is a directory

pub const fn is_symlink(&self) -> bool

Evaluates if this node is a symlink

pub const fn is_file(&self) -> bool

Evaluates if this node is a regular file

pub const fn is_special(&self) -> bool

Evaluates if this node is a special file

pub fn name(&self) -> OsString

Get the node name as OsString, handling name ecaping

Panics

If the name is not valid unicode

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Node

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

Formats the value using the given formatter.

impl Default for Node

fn default() -> Node

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Node

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for Node

fn cmp(&self, other: &Node) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Node

fn eq(&self, other: &Node) -> 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 PartialOrd for Node

fn partial_cmp(&self, other: &Node) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Node

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Node

impl StructuralPartialEq for Node