Struct ProjectGenerator 

pub struct ProjectGenerator { /* private fields */ }

Implementations

impl ProjectGenerator

pub fn discover(start: impl AsRef<Path>) -> Result<Self, ScaffoldError>

Locate the Phoenix project containing start.

Errors

Returns an error when no parent contains the expected Phoenix layout.

pub fn root(&self) -> &Path

pub fn refresh_types(&self) -> Result<bool, ScaffoldError>

Refresh generated TypeScript contracts after a Rust generator runs.

Returns Ok(false) before JavaScript dependencies are installed; Vite will still generate the files when development starts.

Errors

Returns an error when the installed Phoenix Vite generator fails.

pub fn controller( &self, name: &str, options: ControllerOptions, ) -> Result<Vec<PathBuf>, ScaffoldError>

Generate a controller and optionally its conventional resource route.

Errors

Returns an error for invalid names, conflicts, or malformed managed files.

pub fn model( &self, name: &str, options: ModelOptions, ) -> Result<Vec<PathBuf>, ScaffoldError>

Generate a Toasty model and any requested companion artifacts.

--all creates the currently supported cohesive business slice: model, migration, request, API resource, resource controller/route, and index page.

Errors

Returns an error for invalid names, conflicts, or malformed managed files.

pub fn migration( &self, name: &str, options: GenerateOptions, ) -> Result<Vec<PathBuf>, ScaffoldError>

Generate one migration and register it in database/migrations/mod.rs.

Errors

Returns an error for invalid names, conflicts, time, or managed files.

pub fn request( &self, name: &str, options: GenerateOptions, ) -> Result<Vec<PathBuf>, ScaffoldError>

Generate a validated request DTO and update its Rust module.

Errors

Returns an error for invalid names, conflicts, or malformed managed files.

pub fn resource( &self, name: &str, options: GenerateOptions, ) -> Result<Vec<PathBuf>, ScaffoldError>

Generate a browser-safe API resource and update its Rust module.

Errors

Returns an error for invalid names, conflicts, or malformed managed files.

pub fn middleware( &self, name: &str, options: GenerateOptions, ) -> Result<Vec<PathBuf>, ScaffoldError>

Generate a pass-through middleware ready for application logic.

Errors

Returns an error for invalid names, conflicts, or malformed managed files.

pub fn page( &self, name: &str, options: GenerateOptions, ) -> Result<Vec<PathBuf>, ScaffoldError>

Generate a React page plus its Rust Page Props contract.

Errors

Returns an error for invalid names, conflicts, or malformed managed files.

pub fn island( &self, name: &str, options: GenerateOptions, ) -> Result<Vec<PathBuf>, ScaffoldError>

Generate a React Island component.

Errors

Returns an error for invalid names, conflicts, or file-system failures.

pub fn command( &self, name: &str, options: GenerateOptions, ) -> Result<Vec<PathBuf>, ScaffoldError>

Generate a console command and register it in app/commands/mod.rs.

Errors

Returns an error for invalid names, conflicts, or malformed managed files.

pub fn update_core( &self, options: &UpdateProjectOptions, ) -> Result<Vec<PathBuf>, ScaffoldError>

Refresh framework-owned core files without touching business code.

Updates src/lib.rs / src/main.rs, Vite/TS config, config schemas, dependency pins for phoenixrs / @apizero/*, and (when the project uses a database) src/bin/phoenix-manage.rs. Leaves controllers, routes, pages, and user TOML alone.

Errors

Returns an error for invalid local framework roots, I/O failures, or npm failures.

Trait Implementations

impl Clone for ProjectGenerator

fn clone(&self) -> ProjectGenerator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectGenerator

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

Formats the value using the given formatter.