Struct UiTreeFolder

pub struct UiTreeFolder<T, F = ()> {
    pub value: F,
    pub children: BTreeMap<String, Box<UiTreeItem<T, F>>>,
}

Fields

value: F

children: BTreeMap<String, Box<UiTreeItem<T, F>>>

Implementations

impl<T, F> UiTreeFolder<T, F>

pub fn new(value: F) -> Self

pub fn clear(&mut self, value: F)

Clears this folder, and sets a new value for it.

pub fn unique_path( &self, folder: &(impl AsRef<str> + ?Sized), base_file_name: &(impl AsRef<str> + ?Sized), ) -> String

pub fn file(&self, path: &(impl AsRef<str> + ?Sized)) -> Option<&T>

pub fn folder( &self, path: &(impl AsRef<str> + ?Sized), ) -> Option<&UiTreeFolder<T, F>>

pub fn root(&self) -> UiTreeItemRef<'_, T, F>

Returns the root item. This is always a Folder.

pub fn item( &self, path: &(impl AsRef<str> + ?Sized), ) -> Option<UiTreeItemRef<'_, T, F>>

pub fn item_mut( &mut self, path: &(impl AsRef<str> + ?Sized), ) -> Option<UiTreeItemRefMut<'_, T, F>>

pub fn file_mut(&mut self, path: &(impl AsRef<str> + ?Sized)) -> Option<&mut T>

pub fn folder_mut( &mut self, path: &(impl AsRef<str> + ?Sized), ) -> Option<&mut UiTreeFolder<T, F>>

pub fn item_exists(&self, path: &(impl AsRef<str> + ?Sized)) -> bool

pub fn folder_exists(&self, path: &(impl AsRef<str> + ?Sized)) -> bool

pub fn file_exists(&self, path: &(impl AsRef<str> + ?Sized)) -> bool

pub fn add_item( &mut self, path: &(impl AsRef<str> + ?Sized), new_item: UiTreeItem<T, F>, ) -> Result<(), CosmicPathErr>

pub fn add_file( &mut self, path: &(impl AsRef<str> + ?Sized), value: T, ) -> Result<(), CosmicPathErr>

pub fn add_folder( &mut self, path: &(impl AsRef<str> + ?Sized), folder_value: F, ) -> Result<(), CosmicPathErr>

pub fn remove_item( &mut self, path: &(impl AsRef<str> + ?Sized), ) -> Result<UiTreeItem<T, F>, CosmicPathErr>

pub fn remove_file( &mut self, path: &(impl AsRef<str> + ?Sized), ) -> Result<T, CosmicPathErr>

pub fn remove_folder( &mut self, path: &(impl AsRef<str> + ?Sized), ) -> Result<UiTreeFolder<T, F>, CosmicPathErr>

pub fn move_item( &mut self, old_path: &(impl AsRef<str> + ?Sized), new_path: &(impl AsRef<str> + ?Sized), ) -> Result<(), CosmicPathErr>

pub fn files(&self) -> impl Iterator<Item = &T>

pub fn files_mut(&mut self) -> impl Iterator<Item = &mut T>

pub fn files_paths( &self, base_path: String, ) -> impl Iterator<Item = (String, &T)>

pub fn files_paths_mut( &mut self, base_path: String, ) -> impl Iterator<Item = (String, &mut T)>

pub fn set_children( &mut self, children: BTreeMap<String, Box<UiTreeItem<T, F>>>, )

Directly sets the children

pub fn iter(&self) -> impl Iterator<Item = UiTreeItemRef<'_, T, F>>

pub fn iter_paths( &self, base: String, ) -> impl Iterator<Item = (String, UiTreeItemRef<'_, T, F>)>

pub fn for_each_mut<R>( &mut self, empty_folders_pass: bool, filter: impl Fn(&str, &T) -> bool + Copy, on_item: impl FnMut(&str, &mut UiTreeItemRefMut<'_, T, F>) -> Option<R>, )

Performs an action

pub fn for_each<R>( &self, empty_folders_pass: bool, filter: impl Fn(&str, &T) -> bool + Copy, on_item: impl FnMut(&str, &UiTreeItemRef<'_, T, F>) -> Option<R>, )

Performs an action

impl<T, F> UiTreeFolder<T, F>

where F: Default,

pub fn add_folder_all( &mut self, path: &(impl AsRef<str> + ?Sized), ) -> Result<(), CosmicPathErr>

Trait Implementations

impl<T: Clone, F: Clone> Clone for UiTreeFolder<T, F>

fn clone(&self) -> UiTreeFolder<T, F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, F: Debug> Debug for UiTreeFolder<T, F>

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

Formats the value using the given formatter.

impl<T: Default, F: Default> Default for UiTreeFolder<T, F>

fn default() -> UiTreeFolder<T, F>

Returns the “default value” for a type.

impl<'de, T, F> Deserialize<'de> for UiTreeFolder<T, F>

where T: Deserialize<'de>, F: 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, F: PartialEq> PartialEq for UiTreeFolder<T, F>

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

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

const 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, F> Serialize for UiTreeFolder<T, F>

where T: Serialize, F: 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: Eq, F: Eq> Eq for UiTreeFolder<T, F>

impl<T, F> StructuralPartialEq for UiTreeFolder<T, F>