pesde/src/lib.rs

158 lines
4.2 KiB
Rust
Raw Normal View History

2024-07-12 23:09:37 +01:00
// #![deny(missing_docs)] - TODO: bring this back before publishing 0.5
#[cfg(not(any(feature = "roblox", feature = "lune", feature = "luau")))]
compile_error!("at least one of the features `roblox`, `lune`, or `luau` must be enabled");
use crate::lockfile::Lockfile;
2024-07-12 23:09:37 +01:00
use std::path::{Path, PathBuf};
2024-07-17 18:38:01 +01:00
pub mod download;
pub mod linking;
2024-07-12 23:09:37 +01:00
pub mod lockfile;
2024-03-04 20:18:49 +00:00
pub mod manifest;
2024-07-12 23:09:37 +01:00
pub mod names;
2024-07-23 23:53:34 +01:00
#[cfg(feature = "patches")]
2024-07-23 15:37:47 +01:00
pub mod patches;
pub mod resolver;
pub mod scripts;
2024-07-12 23:09:37 +01:00
pub mod source;
2024-07-22 21:00:09 +01:00
pub(crate) mod util;
2024-07-12 23:09:37 +01:00
pub const MANIFEST_FILE_NAME: &str = "pesde.toml";
2024-07-12 23:09:37 +01:00
pub const LOCKFILE_FILE_NAME: &str = "pesde.lock";
pub const DEFAULT_INDEX_NAME: &str = "default";
2024-07-17 18:38:01 +01:00
pub const PACKAGES_CONTAINER_NAME: &str = ".pesde";
2024-07-22 15:41:45 +01:00
pub const MAX_ARCHIVE_SIZE: usize = 4 * 1024 * 1024;
2024-07-12 23:09:37 +01:00
#[derive(Debug, Default, Clone)]
pub struct AuthConfig {
2024-07-22 15:41:45 +01:00
pesde_token: Option<String>,
git_credentials: Option<gix::sec::identity::Account>,
2024-07-12 23:09:37 +01:00
}
impl AuthConfig {
pub fn new() -> Self {
AuthConfig::default()
}
2024-07-22 15:41:45 +01:00
pub fn pesde_token(&self) -> Option<&str> {
self.pesde_token.as_deref()
2024-07-12 23:09:37 +01:00
}
2024-07-22 15:41:45 +01:00
pub fn git_credentials(&self) -> Option<&gix::sec::identity::Account> {
self.git_credentials.as_ref()
}
pub fn with_pesde_token<S: AsRef<str>>(mut self, token: Option<S>) -> Self {
self.pesde_token = token.map(|s| s.as_ref().to_string());
2024-07-12 23:09:37 +01:00
self
}
2024-07-22 15:41:45 +01:00
pub fn with_git_credentials(
mut self,
git_credentials: Option<gix::sec::identity::Account>,
) -> Self {
self.git_credentials = git_credentials;
self
2024-07-12 23:09:37 +01:00
}
}
#[derive(Debug, Clone)]
2024-07-12 23:09:37 +01:00
pub struct Project {
path: PathBuf,
data_dir: PathBuf,
auth_config: AuthConfig,
2024-07-28 17:19:54 +01:00
cas_dir: PathBuf,
2024-07-12 23:09:37 +01:00
}
impl Project {
2024-07-28 17:19:54 +01:00
pub fn new<P: AsRef<Path>, Q: AsRef<Path>, R: AsRef<Path>>(
2024-07-12 23:09:37 +01:00
path: P,
data_dir: Q,
2024-07-28 17:19:54 +01:00
cas_dir: R,
2024-07-12 23:09:37 +01:00
auth_config: AuthConfig,
) -> Self {
Project {
path: path.as_ref().to_path_buf(),
data_dir: data_dir.as_ref().to_path_buf(),
auth_config,
2024-07-28 17:19:54 +01:00
cas_dir: cas_dir.as_ref().to_path_buf(),
2024-07-12 23:09:37 +01:00
}
}
pub fn path(&self) -> &Path {
&self.path
}
pub fn data_dir(&self) -> &Path {
&self.data_dir
}
2024-07-22 15:41:45 +01:00
pub fn auth_config(&self) -> &AuthConfig {
&self.auth_config
}
2024-07-28 17:19:54 +01:00
pub fn cas_dir(&self) -> &Path {
&self.cas_dir
}
2024-07-23 15:37:47 +01:00
pub fn read_manifest(&self) -> Result<String, errors::ManifestReadError> {
let string = std::fs::read_to_string(self.path.join(MANIFEST_FILE_NAME))?;
Ok(string)
2024-07-12 23:09:37 +01:00
}
pub fn deser_manifest(&self) -> Result<manifest::Manifest, errors::ManifestReadError> {
let string = std::fs::read_to_string(self.path.join(MANIFEST_FILE_NAME))?;
Ok(toml::from_str(&string)?)
2024-07-12 23:09:37 +01:00
}
pub fn write_manifest<S: AsRef<[u8]>>(&self, manifest: S) -> Result<(), std::io::Error> {
std::fs::write(self.path.join(MANIFEST_FILE_NAME), manifest.as_ref())
}
pub fn deser_lockfile(&self) -> Result<Lockfile, errors::LockfileReadError> {
let string = std::fs::read_to_string(self.path.join(LOCKFILE_FILE_NAME))?;
Ok(toml::from_str(&string)?)
}
pub fn write_lockfile(&self, lockfile: Lockfile) -> Result<(), errors::LockfileWriteError> {
let string = toml::to_string(&lockfile)?;
std::fs::write(self.path.join(LOCKFILE_FILE_NAME), string)?;
Ok(())
}
2024-07-12 23:09:37 +01:00
}
pub mod errors {
use thiserror::Error;
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum ManifestReadError {
#[error("io error reading manifest file")]
Io(#[from] std::io::Error),
#[error("error deserializing manifest file")]
Serde(#[from] toml::de::Error),
2024-07-12 23:09:37 +01:00
}
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum LockfileReadError {
#[error("io error reading lockfile")]
Io(#[from] std::io::Error),
#[error("error deserializing lockfile")]
Serde(#[from] toml::de::Error),
}
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum LockfileWriteError {
#[error("io error writing lockfile")]
Io(#[from] std::io::Error),
#[error("error serializing lockfile")]
Serde(#[from] toml::ser::Error),
}
}