Struct Tree

pub struct Tree { /* private fields */ }

A tree is a collection of files where installed rocks are located.

lux diverges from the traditional hierarchy employed by luarocks. Instead, we opt for a much simpler approach:

• /rocks/ - contains rocks
• /rocks///etc - documentation and supplementary files for the rock
• /rocks///lib - shared libraries (.so files)
• /rocks///src - library code for the rock
• /bin - binary files produced by various rocks

Implementations

impl Tree

pub fn list(&self) -> Result<HashMap<PackageName, Vec<LocalPackage>>, TreeError>

pub fn as_rock_list(&self) -> Result<Vec<LocalPackage>, TreeError>

impl Tree

pub fn root(&self) -> PathBuf

The root of the tree

pub fn version(&self) -> &LuaVersion

pub fn root_for(&self, package: &LocalPackage) -> PathBuf

pub fn bin(&self) -> PathBuf

pub fn match_rocks(&self, req: &PackageReq) -> Result<RockMatches, TreeError>

pub fn match_rocks_and<F>( &self, req: &PackageReq, filter: F, ) -> Result<RockMatches, TreeError>

where F: Fn(&LocalPackage) -> bool,

pub fn installed_rock_layout( &self, package: &LocalPackage, ) -> Result<RockLayout, TreeError>

Get the RockLayout for an installed package.

pub fn entrypoint_layout(&self, package: &LocalPackage) -> RockLayout

Create a RockLayout for an entrypoint

pub fn dependency_layout(&self, package: &LocalPackage) -> RockLayout

Create a RockLayout for a dependency

pub fn entrypoint(&self, package: &LocalPackage) -> Result<RockLayout>

Create a RockLayout for an entrypoint package, creating the lib and src directories.

pub fn dependency(&self, package: &LocalPackage) -> Result<RockLayout>

Create a RockLayout for a dependency package, creating the lib and src directories.

pub fn lockfile(&self) -> Result<Lockfile<ReadOnly>, TreeError>

pub fn lockfile_path(&self) -> PathBuf

Get this tree’s lockfile path.

pub fn test_tree(&self, config: &Config) -> Result<Tree, TreeError>

The tree in which to install test dependencies

pub fn build_tree(&self, config: &Config) -> Result<Tree, TreeError>

The tree in which to install build dependencies

Trait Implementations

impl Clone for Tree

fn clone(&self) -> Tree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tree

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

Formats the value using the given formatter.

impl UserData for Tree

fn add_methods<M: UserDataMethods<Self>>(methods: &mut M)

Adds custom methods and operators specific to this userdata.

fn add_fields<F>(fields: &mut F)

where F: UserDataFields<Self>,

Adds custom fields specific to this userdata.

fn register(registry: &mut UserDataRegistry<Self>)

Registers this type for use in Lua.