Struct DirSource 

pub struct DirSource { /* private fields */ }

A plugin package rooted at a real directory.

Implementations

impl DirSource

pub fn open(root: impl AsRef<Path>) -> Result<Self>

Open a plugin root. Fails if the directory does not exist or cannot be canonicalized.

pub fn root(&self) -> &Path

The plugin root as given.

pub fn canonical_root(&self) -> &Path

The filesystem-resolved plugin root — the §4.1 containment boundary and the value of PLUGIN_ROOT (§9.1).

Trait Implementations

impl Clone for DirSource

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 DirSource

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

Formats the value using the given formatter.

impl Source for DirSource

type Error = Error

The source’s own failure type. Failures are folded into the loading conversation as Answer::Unavailable, where the spec’s failure boundaries decide how far the damage spreads.

fn kind(&mut self, path: &PackagePath) -> Result<Option<FileKind>, Error>

What kind of entry does path resolve to? None if absent.

fn confined(&mut self, path: &PackagePath) -> Result<bool, Error>

Does path, fully resolved, stay within the plugin root? Sources that cannot contain links may simply return Ok(true).

fn read(&mut self, path: &PackagePath) -> Result<Vec<u8>, Error>

Read the file at path.

fn list(&mut self, path: &PackagePath) -> Result<Vec<DirEntry>, Error>

List the immediate entries of the directory at path.