Struct PkgDir 

pub struct PkgDir { /* private fields */ }

Base directory for cache + vendored output.

This is the single place that knows the internal layout:

<base>/
  cache/      git clones, keyed by host/org/repo/sha  (GitFetcher root)
  vendored/   <name> -> ../cache/…/<entry> symlinks    (VendoredResolver root)

Callers pass one path; cache and vendored derive the rest so no consumer has to replicate the join("cache") / join("vendored") convention.

Example

use mlua_pkg::PkgDir;
use std::path::Path;

let dir = PkgDir::new(".mlua-pkgs");
assert_eq!(dir.cache(), Path::new(".mlua-pkgs/cache"));
assert_eq!(dir.vendored(), Path::new(".mlua-pkgs/vendored"));

Implementations

impl PkgDir

pub fn new(base: impl Into<PathBuf>) -> Self

Wrap an explicit base directory. No filesystem access.

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

<root>/.mlua-pkgs — the conventional location under a project root.

pub fn base(&self) -> &Path

The base directory as given.

pub fn cache(&self) -> PathBuf

<base>/cache — root handed to crate::fetcher::GitFetcher.

pub fn vendored(&self) -> PathBuf

<base>/vendored — root handed to crate::resolvers::VendoredResolver.

pub fn vendored_root(&self, name: &str) -> PathBuf

<base>/vendored/<name> — the symlink install creates for a package without target_dir. It points at the package root (upstream cache checkout or patch_dir); the require root inside it is <root>/<entry> with entry taken from the lockfile (LockedPkg::require_dir).

Trait Implementations

impl Clone for PkgDir

fn clone(&self) -> PkgDir

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PkgDir

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

Formats the value using the given formatter.

impl Eq for PkgDir

impl<T: Into<PathBuf>> From<T> for PkgDir

fn from(p: T) -> Self

Converts to this type from the input type.

impl PartialEq for PkgDir

fn eq(&self, other: &PkgDir) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PkgDir