lune-org/lune
1
1
Fork 0
mirror of https://github.com/lune-org/lune.git synced 2025-04-16 18:03:57 +01:00
Code Issues Projects Releases Packages Wiki Activity

feat(docs): add rustdoc comments

Browse source
This commit is contained in:
Erica Marigold 2024-03-11 22:37:16 +05:30
parent 93b950ce10
commit b9b1ba7d03
No known key found for this signature in database
GPG key ID: 2768CC0C23D245D1
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/cli/build.rs
View file

@ -49,6 +49,9 @@ pub struct BuildCommand {
// TODO: Currently, the file we are patching is user provided, so we should // TODO: Currently, the file we are patching is user provided, so we should
// probably check whether the binary is a valid lune base binary first // probably check whether the binary is a valid lune base binary first
// TODO: Handle whether the compiled bytecode may conflict among breaking luau
// versions
impl BuildCommand { impl BuildCommand {
pub async fn run(self) -> Result<ExitCode> { pub async fn run(self) -> Result<ExitCode> {
let mut output_path = self let mut output_path = self
@ -119,16 +122,21 @@ async fn write_executable_file_to(path: impl AsRef<Path>, bytes: impl AsRef<[u8]
Ok(()) Ok(())
} }
/// Possible ways in which the discovery and/or download of a base binary's path can error
#[derive(Debug, Clone, Error, PartialEq)] #[derive(Debug, Clone, Error, PartialEq)]
pub enum BasePathDiscoveryError<T> { pub enum BasePathDiscoveryError<T> {
/// An error in the decompression of the precompiled target
#[error("decompression error")] #[error("decompression error")]
Decompression(T), Decompression(T),
#[error("precompiled base for target not found for {target}")] #[error("precompiled base for target not found for {target}")]
TargetNotFound { target: String }, TargetNotFound { target: String },
/// An error in the precompiled target download process
#[error("failed to download precompiled binary base")] #[error("failed to download precompiled binary base")]
DownloadError(T), DownloadError(T),
/// An IO related error
#[error("a generic error related to an io operation occurred")] #[error("a generic error related to an io operation occurred")]
IoError(T), IoError(T),
/// Safe to continue, the user did not request any cross-compilation
#[error("neither a custom base path or precompiled target name provided")] #[error("neither a custom base path or precompiled target name provided")]
None, None,
} }