Struct PreviewArgs 

pub struct PreviewArgs {
    pub target: String,
    pub expr: bool,
    pub frame: Option<String>,
    pub backend: Option<CliPreviewBackend>,
    pub theme: Option<CliHydrolysisPreviewTheme>,
    pub platform: Option<CliPreviewPlatform>,
}

Render a #[preview] function or WaterUI expression to a PNG image.

Returns the rendered image directly; the PNG is also written under the project’s managed .water build-cache directory.

The arguments mirror water preview: a function path such as views::home, or — with expr — an inline expression such as text("hello").

Fields

target: String

Preview target: a #[preview] function path (e.g. views::home) or, with expr, a WaterUI expression returning impl View.

expr: bool

Treat target as a WaterUI expression returning impl View (default false). Expression targets require the hydrolysis backend.

frame: Option<String>

Frame size WIDTHxHEIGHT (default 375x667).

backend: Option<CliPreviewBackend>

Rendering backend: apple, android, or hydrolysis. Defaults to the platform’s native backend (apple on macOS/iOS, android on Android).

theme: Option<CliHydrolysisPreviewTheme>

Theme package for the hydrolysis backend (material3). Required when backend is hydrolysis; rejected otherwise.

platform: Option<CliPreviewPlatform>

Target platform: ios, macos, or android. Defaults to this host’s native preview platform.

Implementations

impl PreviewArgs

pub fn resolve(&self, crate_name: &str) -> Result<PreviewRequest>

Resolves the shared PreviewRequest — the same construction water preview applies to its clap arguments.

Errors

Returns an error for a malformed frame or an unsupported platform/backend/theme combination.

Trait Implementations

impl Debug for PreviewArgs

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PreviewArgs

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PreviewArgs

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.