Enum Hook 

pub enum Hook {
    OnNavigate {
        from: PathBuf,
        to: PathBuf,
    },
    OnScanStart {
        path: PathBuf,
    },
    OnScanComplete {
        path: PathBuf,
        total_files: u64,
        total_dirs: u64,
        total_size: u64,
    },
    OnScanError {
        path: PathBuf,
        error: String,
    },
    OnDeleteStart {
        items: Vec<PathBuf>,
        use_trash: bool,
    },
    OnDeleteComplete {
        deleted: usize,
        failed: usize,
        bytes_freed: u64,
    },
    OnCopyComplete {
        succeeded: usize,
        failed: usize,
        bytes_copied: u64,
    },
    OnMoveComplete {
        succeeded: usize,
        failed: usize,
    },
    OnRenameComplete {
        source: PathBuf,
        new_path: PathBuf,
    },
    OnDuplicatesFound {
        group_count: usize,
        wasted_bytes: u64,
    },
    OnAgeAnalysisComplete {
        stale_dirs: usize,
        files: u64,
        average_age_secs: u64,
    },
    OnStartup,
    OnShutdown,
}

Events that plugins can hook into.

Variants

OnNavigate

The explorer moved to another directory.

Fields

from: PathBuf

Previous directory path.

to: PathBuf

New directory path.

OnScanStart

A full scan started.

Fields

path: PathBuf

Root path being scanned.

OnScanComplete

A full scan finished.

Fields

path: PathBuf

Root path that was scanned.

total_files: u64

Total files found.

total_dirs: u64

Total directories found.

total_size: u64

Total size in bytes.

OnScanError

A full scan failed.

Fields

path: PathBuf

Root path that failed.

error: String

Error message.

OnDeleteStart

A delete is about to start. Awaited; a plugin can veto it.

Fields

items: Vec<PathBuf>

Items to be deleted.

use_trash: bool

Whether using trash (recoverable).

OnDeleteComplete

A delete finished.

Fields

deleted: usize

Number of items successfully deleted.

failed: usize

Number of items that failed to delete.

bytes_freed: u64

Total bytes freed.

OnCopyComplete

A copy finished.

Fields

succeeded: usize

Number of items successfully copied.

failed: usize

Number of items that failed.

bytes_copied: u64

Total bytes copied.

OnMoveComplete

A move finished.

Fields

succeeded: usize

Number of items successfully moved.

failed: usize

Number of items that failed.

OnRenameComplete

A rename finished.

Fields

source: PathBuf

Original path.

new_path: PathBuf

New path after rename.

OnDuplicatesFound

Duplicate analysis finished.

Fields

group_count: usize

Number of duplicate groups found.

wasted_bytes: u64

Total wasted space in bytes.

OnAgeAnalysisComplete

Age analysis finished.

Fields

stale_dirs: usize

Number of stale directories found.

files: u64

Files whose ages were counted.

average_age_secs: u64

Their average age, in seconds.

OnStartup

The explorer started.

OnShutdown

The explorer is about to quit; awaited briefly.

Implementations

impl Hook

pub fn name(&self) -> &'static str

The function a plugin defines to receive this hook.

Trait Implementations

impl Clone for Hook

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Hook

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Hook

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Hook

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.