Struct ScanTarget 

pub struct ScanTarget { /* private fields */ }

A validated scan target path.

Ensures the path exists at construction time.

Implementations

impl ScanTarget

pub fn new(path: impl AsRef<Path>) -> Result<Self, PathValidationError>

Create a new ScanTarget after validating the path exists.

pub fn file(path: impl AsRef<Path>) -> Result<Self, PathValidationError>

Create a ScanTarget for a file, validating it’s actually a file.

pub fn directory(path: impl AsRef<Path>) -> Result<Self, PathValidationError>

Create a ScanTarget for a directory, validating it’s actually a directory.

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

Create a ScanTarget without validation (for testing or trusted paths).

Safety

The caller must ensure the path is valid for the intended use.

pub fn path(&self) -> &Path

Get the underlying path reference.

pub fn to_path_buf(&self) -> PathBuf

Get the path as a PathBuf.

pub fn into_path_buf(self) -> PathBuf

Consume self and return the inner PathBuf.

pub fn is_file(&self) -> bool

Check if the target is a file.

pub fn is_dir(&self) -> bool

Check if the target is a directory.

pub fn file_name(&self) -> Option<&OsStr>

Get the file name component if present.

pub fn parent(&self) -> Option<&Path>

Get the parent directory if present.

Trait Implementations

impl AsRef<Path> for ScanTarget

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ScanTarget

fn clone(&self) -> ScanTarget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScanTarget

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

Formats the value using the given formatter.

impl From<ScanTarget> for PathBuf

fn from(target: ScanTarget) -> Self

Converts to this type from the input type.