Struct radicle_surf::file_system::Directory

pub struct Directory {
    pub name: Label,
    pub entries: NonEmpty<DirectoryContents>,
}

A Directory consists of its Label and its entries. The entries are a set of DirectoryContents and there should be at least one entry. This is because empty directories do not generally exist in VCSes.

Fields

name: Label

entries: NonEmpty<DirectoryContents>

Methods

impl Directory

pub fn size(&self) -> usize

Get the total size, in bytes, of a Directory. The size is the sum of all files that can be reached from this Directory.

Examples

use radicle_surf::file_system::{Directory, DirectoryContents, File, Label};
use radicle_surf::file_system::unsound;

let files = (
    DirectoryContents::file(unsound::label::new("main.rs"), b"println!(\"Hello, world!\")"),
    vec![DirectoryContents::file(unsound::label::new("lib.rs"), b"struct Hello(String)")],
).into();

let directory = Directory {
    name: Label::root(),
    entries: files,
};

assert_eq!(directory.size(), 45);

use nonempty::NonEmpty;
use radicle_surf::file_system::{Directory, DirectoryContents, File, Label};
use radicle_surf::file_system::unsound;

let mut entries: NonEmpty<DirectoryContents> = (
    DirectoryContents::file(unsound::label::new("main.rs"), b"println!(\"Hello, world!\")"),
    vec![DirectoryContents::file(unsound::label::new("lib.rs"), b"struct Hello(String)")],
).into();

let subdir = DirectoryContents::sub_directory(Directory {
    name: unsound::label::new("test"),
    entries: NonEmpty::new(DirectoryContents::file(
        unsound::label::new("mod.rs"),
        b"assert_eq!(1 + 1, 2);",
    )),
});

entries.push(subdir);

let directory = Directory {
    name: Label::root(),
    entries: entries,
};

assert_eq!(directory.size(), 66);

pub fn list_directory(&self) -> Vec<(Label, SystemType)>

List the current Directory's files and sub-directories.

pub fn find_file(&self, path: &Path) -> Option<File>

Find a File in the directory given the Path to the File.

This operation fails if the path does not lead to the File.

pub fn find_directory(&self, path: &Path) -> Option<Self>

Find a Directory in the directory given the Path to the Directory.

This operation fails if the path does not lead to the Directory.

Trait Implementations

impl Clone for Directory

fn clone(&self) -> Directory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Directory

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

Formats the value using the given formatter.

impl Eq for Directory

impl PartialEq<Directory> for Directory

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Directory

impl StructuralPartialEq for Directory