Struct trash::TrashContext

pub struct TrashContext { /* private fields */ }

A collection of preferences for trash operations.

Implementations

impl TrashContext

pub const fn new() -> Self

pub fn delete<T: AsRef<Path>>(&self, path: T) -> Result<(), Error>

Removes a single file or directory.

When a symbolic link is provided to this function, the symbolic link will be removed and the link target will be kept intact.

Example

use std::fs::File;
use trash::delete;
File::create("delete_me").unwrap();
trash::delete("delete_me").unwrap();
assert!(File::open("delete_me").is_err());

pub fn delete_all<I, T>(&self, paths: I) -> Result<(), Error>where
    I: IntoIterator<Item = T>,
    T: AsRef<Path>,

Removes all files/directories specified by the collection of paths provided as an argument.

When a symbolic link is provided to this function, the symbolic link will be removed and the link target will be kept intact.

Example

use std::fs::File;
use trash::delete_all;
File::create("delete_me_1").unwrap();
File::create("delete_me_2").unwrap();
delete_all(&["delete_me_1", "delete_me_2"]).unwrap();
assert!(File::open("delete_me_1").is_err());
assert!(File::open("delete_me_2").is_err());

Trait Implementations

impl Clone for TrashContext

fn clone(&self) -> TrashContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TrashContext

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

Formats the value using the given formatter.

impl Default for TrashContext

fn default() -> TrashContext

Returns the “default value” for a type.