Struct libfortress::Directory

pub struct Directory {
    pub entries: HashSet<ID>,
    pub name: Option<String>,
    /* private fields */
}

A directory is a list of references to Entries and Directories, much like a filesystem directory. History is always ordered (by timestamp) and consistent (no double adds or removes of non-existant IDs).

Fields

entries: HashSet<ID>

name: Option<String>

Implementations

impl Directory

pub fn new() -> Directory

pub fn new_root() -> Directory

pub fn get_id(&self) -> &ID

pub fn get_history(&self) -> &[DirectoryHistory]

pub fn get_name(&self) -> Option<&str>

pub fn add(&mut self, id: ID)

pub fn add_with_time(&mut self, id: ID, time: u64)

pub fn remove(&mut self, id: ID)

pub fn remove_with_time(&mut self, id: ID, time: u64)

pub fn rename<S: Into<String>>(&mut self, name: S)

pub fn rename_with_time<S: Into<String>>(&mut self, name: S, time: u64)

pub fn list_entries<'a>(&'a self, database: &Database) -> Vec<&'a ID>

List all Entry entries in this directory.

pub fn list_directories<'a>(
    &'a self,
    database: &'a Database
) -> impl Iterator<Item = &'a ID> + '_

List all Directory entries in this directory.

pub fn contains(&self, id: &ID) -> bool

pub fn merge(&self, other: &Directory) -> Option<Directory>

Merge self and other, returning a new Directory. Returns None if there is a conflict.

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

Returns true only if it is safe to replace self with other in the Database. This is only true if doing so is a non-destructive operation (i.e. history is perserved).

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<'de> Deserialize<'de> for Directory

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
    D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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: &Rhs) -> bool

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

impl Serialize for Directory

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 Directory

impl StructuralEq for Directory

impl StructuralPartialEq for Directory