Struct Project

pub struct Project { /* private fields */ }

Implementations

impl Project

pub fn current() -> Result<Option<Self>, ProjectError>

pub fn current_or_err() -> Result<Self, ProjectError>

pub fn from_exact(start: impl AsRef<Path>) -> Result<Option<Self>, ProjectError>

pub fn from(start: impl AsRef<Path>) -> Result<Option<Self>, ProjectError>

pub fn toml_path(&self) -> PathBuf

Get the lux.toml path.

pub fn extra_rockspec_path(&self) -> PathBuf

Get the extra.rockspec path.

pub fn lockfile_path(&self) -> PathBuf

Get the lux.lock lockfile path.

pub fn lockfile(&self) -> Result<ProjectLockfile<ReadOnly>, ProjectError>

Get the lux.lock lockfile in the project root.

pub fn try_lockfile( &self, ) -> Result<Option<ProjectLockfile<ReadOnly>>, ProjectError>

Get the lux.lock lockfile in the project root, if present.

pub fn root(&self) -> &ProjectRoot

pub fn toml(&self) -> &PartialProjectToml

pub fn local_rockspec(&self) -> Result<LocalLuaRockspec, IntoLocalRockspecError>

pub fn remote_rockspec( &self, ) -> Result<RemoteLuaRockspec, IntoRemoteRockspecError>

pub fn extra_rockspec( &self, ) -> Result<Option<PartialLuaRockspec>, PartialRockspecError>

pub fn tree(&self, config: &Config) -> Result<Tree, ProjectTreeError>

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

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

pub fn lua_version( &self, config: &Config, ) -> Result<LuaVersion, LuaVersionError>

pub async fn add( &mut self, dependencies: DependencyType<PackageReq>, package_db: &RemotePackageDB, ) -> Result<(), ProjectEditError>

pub async fn add_git( &mut self, dependencies: LuaDependencyType<GitUrlShorthand>, ) -> Result<(), ProjectEditError>

pub async fn remove( &mut self, dependencies: DependencyType<PackageName>, ) -> Result<(), ProjectEditError>

pub async fn upgrade( &mut self, dependencies: LuaDependencyType<PackageName>, package_db: &RemotePackageDB, ) -> Result<(), ProjectEditError>

pub async fn upgrade_all( &mut self, package_db: &RemotePackageDB, ) -> Result<(), ProjectEditError>

pub async fn set_pinned_state( &mut self, dependencies: LuaDependencyType<PackageName>, pin: PinnedState, ) -> Result<(), PinError>

pub fn project_files(&self) -> Vec<PathBuf>

Trait Implementations

impl Clone for Project

fn clone(&self) -> Project

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Project

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

Formats the value using the given formatter.

impl UserData for Project

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.