Struct UnityProject

pub struct UnityProject { /* private fields */ }

Implementations

impl UnityProject

pub async fn add_package_request<'env>( &self, env: &'env impl PackageCollection, packages: &[PackageInfo<'env>], operation: AddPackageOperation, allow_prerelease: bool, ) -> Result<PendingProjectChanges<'env>, AddPackageErr>

Creates a new AddPackageRequest to add the specified packages.

You should call apply_pending_changes to apply the changes after confirming to the user.

impl UnityProject

pub async fn migrate_unity_2022( &mut self, collection: &impl PackageCollection, installer: &impl PackageInstaller, ) -> Result<(), MigrateUnity2022Error>

impl UnityProject

pub async fn migrate_vpm( &mut self, collection: &impl PackageCollection, installer: &impl PackageInstaller, include_prerelease: bool, ) -> Result<(), MigrateVpmError>

impl UnityProject

pub async fn apply_pending_changes<'env, Env: PackageInstaller>( &mut self, env: &'env Env, request: PendingProjectChanges<'env>, ) -> Result<()>

Applies the changes specified in AddPackageRequest to the project.

This will also save the manifest changes

impl UnityProject

pub async fn detect_project_type(&self) -> ProjectType

impl UnityProject

pub async fn reinstall_request<'env>( &self, env: &'env impl PackageCollection, packages: &[&str], ) -> Result<PendingProjectChanges<'env>, ReinstalPackagesError>

impl UnityProject

pub async fn remove_request( &self, remove: &[&str], ) -> Result<PendingProjectChanges<'static>, RemovePackageErr>

Remove specified package from self project.

This doesn’t look packages not listed in vpm-maniefst.json.

impl UnityProject

pub fn should_resolve(&self) -> bool

Returns whether the project should be resolved.

The project will be resolved if: (not exhaustive)

• some packages defined in locked section are missing
• some packages defined in dependencies section are missing
• some dependencies of unlocked packages are missing

pub async fn resolve_request<'env>( &self, env: &'env impl PackageCollection, ) -> Result<PendingProjectChanges<'env>, ResolvePackageErr>

impl UnityProject

pub async fn load(io: DefaultProjectIo) -> Result<Self>

impl UnityProject

pub fn io(&self) -> &DefaultProjectIo

pub async fn save(&mut self) -> Result<()>

impl UnityProject

pub fn locked_packages(&self) -> impl Iterator<Item = LockedDependencyInfo<'_>>

pub fn dependencies(&self) -> impl Iterator<Item = &str>

pub fn get_locked(&self, name: &str) -> Option<LockedDependencyInfo<'_>>

pub fn is_locked(&self, name: &str) -> bool

pub fn all_packages(&self) -> impl Iterator<Item = LockedDependencyInfo<'_>>

pub fn unlocked_packages(&self) -> &[(Box<str>, Option<PackageManifest>)]

pub fn installed_packages( &self, ) -> impl Iterator<Item = (&str, &PackageManifest)>

pub fn get_installed_package(&self, name: &str) -> Option<&PackageManifest>

pub fn all_installed_packages(&self) -> impl Iterator<Item = &PackageManifest>

pub fn unity_version(&self) -> UnityVersion

pub fn unity_revision(&self) -> Option<&str>

pub fn has_upm_package(&self, name: &str) -> bool

pub fn add_dependency_raw(&mut self, name: &str, version: DependencyRange)

Adds dependency without actually adding package. This only modifies manifest

impl UnityProject

pub fn project_dir(&self) -> &Path

Trait Implementations

impl Debug for UnityProject

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

Formats the value using the given formatter.