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.
Auto Trait Implementations§
impl Freeze for LocalProjectToml
impl RefUnwindSafe for LocalProjectToml
impl Send for LocalProjectToml
impl Sync for LocalProjectToml
impl Unpin for LocalProjectToml
impl UnsafeUnpin for LocalProjectToml
impl UnwindSafe for LocalProjectToml
Blanket Implementations§
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> 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> LuaVersionCompatibility for Twhere
T: Rockspec,
impl<T> LuaVersionCompatibility for Twhere
T: Rockspec,
Source§fn validate_lua_version(
&self,
version: &LuaVersion,
) -> Result<(), LuaVersionError>
fn validate_lua_version( &self, version: &LuaVersion, ) -> Result<(), LuaVersionError>
Ensures that the rockspec is compatible with the specified lua version.
Returns an error if the rockspec is not compatible.
Source§fn validate_lua_version_from_config(
&self,
config: &Config,
) -> Result<(), LuaVersionError>
fn validate_lua_version_from_config( &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.
Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<T, S> SpanWrap<S> for Twhere
S: WrappingSpan<T>,
impl<T, S> SpanWrap<S> for Twhere
S: WrappingSpan<T>,
Source§fn with_span(self, span: S) -> <S as WrappingSpan<Self>>::Spanned
fn with_span(self, span: S) -> <S as WrappingSpan<Self>>::Spanned
Invokes
WrappingSpan::make_wrapped to wrap an AST node in a span.