Struct garbage::TrashDir

pub struct TrashDir(pub PathBuf);

A trash directory represented by a path.

Implementations

impl TrashDir

pub fn from(path: impl AsRef<Path>) -> Self

Constructor for a new trash directory.

pub fn get_home_trash() -> Self

Gets your user's "home" trash directory.

According to Trash spec v1.0:

For every user2 a “home trash” directory MUST be available. Its name and location are $XDG_DATA_HOME/Trash $XDG_DATA_HOME is the base directory for user-specific data, as defined in the Desktop Base Directory Specification.

pub fn from_opt(opt: Option<impl AsRef<Path>>) -> Self

Create a trash directory from an optional path

If the option is None, then the home trash will be selected instead.

pub fn create(&self) -> Result<(), Error>

Actually create the directory on disk corresponding to this trash directory

pub fn path(&self) -> &Path

Returns the path to this trash directory.

pub fn files_dir(&self) -> Result<PathBuf, Error>

Get the files directory

pub fn info_dir(&self) -> Result<PathBuf, Error>

Get the info directory

pub fn check_info_dir(&self) -> Result<Option<PathBuf>, Error>

Get the info directory

pub fn iter(&self) -> Result<TrashDirIter, Error>

Iterate over trash infos within this trash directory

Trait Implementations

impl Clone for TrashDir

fn clone(&self) -> TrashDir

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TrashDir

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

Formats the value using the given formatter.