Struct Project 

pub struct Project { /* private fields */ }

Represents a WaterUI project with its manifest and crate information.

Implementations

impl Project

pub async fn run( &self, device: impl Device, hot_reload: bool, ) -> Result<Running, FailToRun>

Run the WaterUI project on the specified device.

This method handles building, packaging, and running the project.

Errors

• If any step in the build, package, or run process fails.

pub fn root(&self) -> &Path

Get the root path of the project.

Same as the directory containing Water.toml.

pub fn target_dir(&self) -> &Path

Get the target directory for Rust build artifacts.

pub const fn backends(&self) -> &Backends

Get the backends configured for the project.

pub fn crate_name(&self) -> &str

Get the crate name of the project.

pub const fn apple_backend(&self) -> Option<&AppleBackend>

Get the Apple backend configuration if available.

pub fn backend_path<B: Backend>(&self) -> PathBuf

Get the full path to a backend directory.

Returns project.root() / backends.path / B::DEFAULT_PATH.

pub fn backend_relative_path<B: Backend>(&self) -> PathBuf

Get the relative path to a backend directory from project root.

Returns backends.path / B::DEFAULT_PATH.

pub const fn android_backend(&self) -> Option<&AndroidBackend>

Get the Android backend configuration if available.

pub const fn manifest(&self) -> &Manifest

Get the manifest of the project.

pub const fn bundle_identifier(&self) -> &str

Get the bundle identifier of the project.

pub async fn clean(&self, platform: impl Platform) -> Result<(), Report>

Clean build artifacts for the project on the specified platform.

Errors

Returns an error if cleaning fails.

pub async fn clean_all(&self) -> Result<(), Report>

Clean all build artifacts for the project.

This cleans:

• Rust target directory
• Apple build artifacts (if backend configured)
• Android build artifacts (if backend configured)

Errors

Returns an error if any cleaning operation fails.

pub async fn package( &self, platform: impl Platform, options: PackageOptions, ) -> Result<Artifact, Report>

Package the project for the specified platform.

Errors

Returns an error if packaging fails.

impl Project

pub async fn create( path: impl AsRef<Path>, options: CreateOptions, ) -> Result<Self, FailToCreateProject>

Create a new WaterUI project at the specified path.

This creates the project directory, scaffolds root files (Cargo.toml, src/lib.rs), and saves the Water.toml manifest. Use init_apple_backend() and init_android_backend() to scaffold platform backends after creation.

Errors

• FailToCreateProject::DirectoryExists: If the directory already exists.
• FailToCreateProject::CreateDir: If creating the directory fails.
• FailToCreateProject::Scaffold: If scaffolding files fails.
• FailToCreateProject::SaveManifest: If saving the manifest fails.

pub async fn init_apple_backend(&mut self) -> Result<(), FailToInitBackend>

Initialize the Apple backend for this project.

This scaffolds the Apple backend files and updates the manifest.

Errors

Returns an error if scaffolding fails.

pub async fn init_android_backend(&mut self) -> Result<(), FailToInitBackend>

Initialize the Android backend for this project.

This scaffolds the Android backend files and updates the manifest.

Errors

Returns an error if scaffolding fails.

pub async fn open(path: impl AsRef<Path>) -> Result<Self, FailToOpenProject>

Open a WaterUI project located at the specified path.

This loads both the Water.toml manifest and the Cargo.toml file. For playground projects, backends are automatically initialized if not configured.

Errors

• FailToOpenProject::Manifest: If there was an error opening the Water.toml manifest.
• FailToOpenProject::CargoManifest: If there was an error reading the Cargo.toml file.
• FailToOpenProject::MissingCrateName: If the crate name is missing in Cargo.toml.

Trait Implementations

impl Clone for Project

fn clone(&self) -> Project

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Project

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

Formats the value using the given formatter.