pub struct LocalProjectToml { /* private fields */ }
Expand description
The lux.toml
file, after being properly deserialized.
This struct may be used to build a local version of a project.
To build a rockspec, use RemoteProjectToml
.
Implementations§
Source§impl LocalProjectToml
impl LocalProjectToml
pub fn run(&self) -> Option<&PerPlatform<RunSpec>>
Sourcepub fn to_lua_rockspec(&self) -> Result<LocalLuaRockspec, LuaRockspecError>
pub fn to_lua_rockspec(&self) -> Result<LocalLuaRockspec, LuaRockspecError>
Convert this project TOML to a Lua rockspec. Fails if there is no valid project root or if there are off-spec dependencies.
Trait Implementations§
Source§impl Debug for LocalProjectToml
impl Debug for LocalProjectToml
Source§impl HasIntegrity for LocalProjectToml
impl HasIntegrity for LocalProjectToml
Source§impl Rockspec for LocalProjectToml
impl Rockspec for LocalProjectToml
type Error = ProjectTomlError
fn package(&self) -> &PackageName
fn version(&self) -> &PackageVersion
fn description(&self) -> &RockDescription
fn supported_platforms(&self) -> &PlatformSupport
fn lua(&self) -> &PackageVersionReq
fn dependencies(&self) -> &PerPlatform<Vec<LuaDependencySpec>>
fn build_dependencies(&self) -> &PerPlatform<Vec<LuaDependencySpec>>
fn external_dependencies( &self, ) -> &PerPlatform<HashMap<String, ExternalDependencySpec>>
fn test_dependencies(&self) -> &PerPlatform<Vec<LuaDependencySpec>>
fn build(&self) -> &PerPlatform<BuildSpec>
fn test(&self) -> &PerPlatform<TestSpec>
fn build_mut(&mut self) -> &mut PerPlatform<BuildSpec>
fn test_mut(&mut self) -> &mut PerPlatform<TestSpec>
fn format(&self) -> &Option<RockspecFormat>
fn source(&self) -> &PerPlatform<RemoteRockSource>
fn source_mut(&mut self) -> &mut PerPlatform<RemoteRockSource>
fn deploy(&self) -> &PerPlatform<DeploySpec>
fn deploy_mut(&mut self) -> &mut PerPlatform<DeploySpec>
Source§fn to_lua_remote_rockspec_string(&self) -> Result<String, Self::Error>
fn to_lua_remote_rockspec_string(&self) -> Result<String, Self::Error>
Converts the rockspec to a string that can be uploaded to a luarocks server.
Source§fn binaries(&self) -> RockBinaries
fn binaries(&self) -> RockBinaries
Shorthand to extract the binaries that are part of the rockspec.
Source§impl UserData for LocalProjectToml
impl UserData for LocalProjectToml
Source§fn add_methods<M: UserDataMethods<Self>>(methods: &mut M)
fn add_methods<M: UserDataMethods<Self>>(methods: &mut M)
Adds custom methods and operators specific to this userdata.
Source§fn add_fields<F>(fields: &mut F)where
F: UserDataFields<Self>,
fn add_fields<F>(fields: &mut F)where
F: UserDataFields<Self>,
Adds custom fields specific to this userdata.
Source§fn register(registry: &mut UserDataRegistry<Self>)
fn register(registry: &mut UserDataRegistry<Self>)
Registers this type for use in Lua. Read more
Auto Trait Implementations§
impl Freeze for LocalProjectToml
impl RefUnwindSafe for LocalProjectToml
impl Send for LocalProjectToml
impl Sync for LocalProjectToml
impl Unpin for LocalProjectToml
impl UnwindSafe for LocalProjectToml
Blanket Implementations§
Source§impl<Src, Scheme> ApproxFrom<Src, Scheme> for Srcwhere
Scheme: ApproxScheme,
impl<Src, Scheme> ApproxFrom<Src, Scheme> for Srcwhere
Scheme: ApproxScheme,
Source§fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>
fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>
Convert the given value into an approximately equivalent representation.
Source§impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Srcwhere
Dst: ApproxFrom<Src, Scheme>,
Scheme: ApproxScheme,
impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Srcwhere
Dst: ApproxFrom<Src, Scheme>,
Scheme: ApproxScheme,
Source§type Err = <Dst as ApproxFrom<Src, Scheme>>::Err
type Err = <Dst as ApproxFrom<Src, Scheme>>::Err
The error type produced by a failed conversion.
Source§fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>
fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>
Convert the subject into an approximately equivalent representation.
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T, Dst> ConvAsUtil<Dst> for T
impl<T, Dst> ConvAsUtil<Dst> for T
Source§impl<T> ConvUtil for T
impl<T> ConvUtil for T
Source§fn approx_as<Dst>(self) -> Result<Dst, Self::Err>where
Self: Sized + ApproxInto<Dst>,
fn approx_as<Dst>(self) -> Result<Dst, Self::Err>where
Self: Sized + ApproxInto<Dst>,
Approximate the subject to a given type with the default scheme.
Source§fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err>
fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err>
Approximate the subject to a given type with a specific scheme.
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoLuaMulti for Twhere
T: IntoLua,
impl<T> IntoLuaMulti for Twhere
T: IntoLua,
Source§fn into_lua_multi(self, lua: &Lua) -> Result<MultiValue, Error>
fn into_lua_multi(self, lua: &Lua) -> Result<MultiValue, Error>
Performs the conversion.
unsafe fn push_into_stack_multi(self, lua: &RawLua) -> Result<i32, Error>
Source§impl<T> LuaVersionCompatibility for Twhere
T: Rockspec,
impl<T> LuaVersionCompatibility for Twhere
T: Rockspec,
Source§fn validate_lua_version(&self, config: &Config) -> Result<(), LuaVersionError>
fn validate_lua_version(&self, config: &Config) -> Result<(), LuaVersionError>
Ensures that the rockspec is compatible with the lua version established in the config.
Returns an error if the rockspec is not compatible.
Source§fn lua_version_matches(
&self,
config: &Config,
) -> Result<LuaVersion, LuaVersionError>
fn lua_version_matches( &self, config: &Config, ) -> Result<LuaVersion, LuaVersionError>
Ensures that the rockspec is compatible with the lua version established in the config,
and returns the lua version from the config if it is compatible.
Source§fn supports_lua_version(&self, lua_version: &LuaVersion) -> bool
fn supports_lua_version(&self, lua_version: &LuaVersion) -> bool
Checks if the rockspec supports the given lua version.
Source§fn lua_version(&self) -> Option<LuaVersion>
fn lua_version(&self) -> Option<LuaVersion>
Returns the lua version required by the rockspec.