sscan 0.15.1

A scriptable file/process/network scanner
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

//! # Error type definitions for [`FsApi`]
//!
//! This module defines the comprehensive error type for the sscan
//! filesystem APIs. Any errors returned from the [`FsApi`] or a
//! [`PathObj`] will be of this type.
//!
//! [`FsApi`]: super::FsApi
//! [`PathObj`]: super::path_obj::PathObj

use crate::userscript_api::include::{LuaError, LuaExternalError};
use std::path::PathBuf;
use thiserror::Error as ThisError;

/// Comprehensive error type for [`FsApi`]
///
/// [`FsApi`]: super::FsApi
#[derive(ThisError, Debug)]
pub enum Error {
    /// The provided path is invalid.
    #[error("invalid path `{path}`: {source}")]
    InvalidPath {
        /// The erroneous path that was provided.
        path: PathBuf,

        /// Inner IO error that occurred.
        source: std::io::Error,
    },

    /// Unable to read the requested dir.
    #[error("failed to list dir {}: {source}", path.to_string_lossy())]
    ReadDirError {
        /// Path to the directory
        path: PathBuf,

        /// Inner IO error that occurred.
        source: std::io::Error,
    },

    /// A directory operation was called on a path that is not a dir.
    #[error("expected a directory, but got {path}")]
    NotADirectory {
        /// The path that was not a directory.
        path: PathBuf,
    },
}

impl From<Error> for LuaError {
    fn from(value: Error) -> Self {
        value.into_lua_err()
    }
}