Struct librojo::path_map::PathMap

pub struct PathMap<T> { /* fields omitted */ }

A map from paths to another type, like instance IDs, with a bit of additional data that enables removing a path and all of its child paths from the tree more quickly.

Methods

impl<T> PathMap<T>

pub fn new() -> PathMap<T>

pub fn get(&self, path: &Path) -> Option<&T>

pub fn get_mut(&mut self, path: &Path) -> Option<&mut T>

pub fn insert(&mut self, path: PathBuf, value: T)

pub fn remove(&mut self, root_path: &Path) -> Option<T>

pub fn descend(&self, start_path: &Path, target_path: &Path) -> PathBuf

Traverses the route between start_path and target_path and returns the path closest to target_path in the tree.

This is useful when trying to determine what paths need to be marked as altered when a change to a path is registered. Depending on the order of FS events, a file remove event could be followed by that file's directory being removed, in which case we should process that directory's parent.

Trait Implementations

impl<T: Debug> Debug for PathMap<T>

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

Formats the value using the given formatter.

impl<T> Default for PathMap<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T> Serialize for PathMap<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.