Struct PartialProjectToml

pub struct PartialProjectToml { /* private fields */ }

The lux.toml file. The only required fields are package and build, which are required to build a project using lux build. The rest of the fields are optional, but are required to build a rockspec.

Implementations

impl PartialProjectToml

pub fn into_local( &self, ) -> Result<LocalProjectToml, LocalProjectTomlValidationError>

Convert the PartialProjectToml struct into a LocalProjectToml struct, making it ready to be used for building a project.

pub fn into_remote( &self, ) -> Result<RemoteProjectToml, RemoteProjectTomlValidationError>

Convert the PartialProjectToml struct into a RemoteProjectToml struct, making it ready to be serialized into a rockspec. A source must be provided for the rockspec to be valid.

pub fn package(&self) -> &PackageName

pub fn version(&self) -> Result<PackageVersion, GenerateVersionError>

Returns the current package version, which may be generated from a template

pub fn merge(self, other: PartialLuaRockspec) -> Self

Merge the ProjectToml struct with an unvalidated LuaRockspec. The final merged struct can then be validated.

Trait Implementations

impl Clone for PartialProjectToml

fn clone(&self) -> PartialProjectToml

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PartialProjectToml

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PartialProjectToml

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl HasIntegrity for PartialProjectToml

fn hash(&self) -> Result<Integrity>

impl LuaVersionCompatibility for PartialProjectToml

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.

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.

fn supports_lua_version(&self, lua_version: &LuaVersion) -> bool

Checks if the rockspec supports the given lua version.

fn lua_version(&self) -> Option<LuaVersion>

Returns the lua version required by the rockspec.

impl UserData for PartialProjectToml

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.