Expand description
Shared configuration, validation, paths, and diagnostics for cargo-ferry.
Modules§
- brand
- Product names live here so a future rename does not leak across generators.
- windows_
private_ directory - Atomic private-directory creation and handle validation on Windows. Atomic private filesystem-object creation and handle validation on Windows.
Structs§
- Android
Config - Android build settings.
- AppConfig
- Application identity and window defaults.
- AppWindow
Config - Initial application window preferences.
- Artifact
Digest - Deterministic SHA-256 identity of one artifact file or directory tree.
- Bool
Capability - Capability represented by a single enable flag.
- Capabilities
Config - Runtime capability configuration.
- Deep
Links Capability - Deep-link configuration and input allowlists.
- Directory
Filesystem Identity - Opaque, versioned identity of one directory filesystem object.
- Directory
Identity Error - Sanitized failure from filesystem identity capture, parsing, or verification.
- Extensions
Config - Platform extension targets.
- Ferry
Config - Complete, versioned
ferry.tomldocument. - IosConfig
- Apple platform build settings.
- Live
Activity Config - Live Activity extension configuration.
- Network
Capability - Network status and probe configuration.
- Notification
Capability - Notification capability configuration.
- Permission
Config - One optional permission and its operating-system prompt text.
- Permissions
Config - Permission declarations that generate platform manifests and purpose strings.
- PngMetadata
- Metadata read from a validated PNG without trusting filename extensions.
- Project
Assets - Validated project icon and splash image bytes.
- Project
Names - Validated names derived from the value passed to
cargo ferry new. - Regular
File Filesystem Identity - Opaque, versioned identity of one single-link regular file.
- Regular
File Stream Error - Secret-free retained-handle stream inspection error.
- Retained
Directory Identity - Retained, policy-neutral handle and identity for one exact directory.
- Retained
Regular File Identity - Retained identity guard for one exact single-link regular file.
- Validation
Issue - One actionable configuration validation problem.
- Widget
Config - Widget extension configuration.
Enums§
- Android
Abi - Supported Android ABI.
- Android
Live Activity Fallback - Android presentation used when iOS Live Activities are enabled.
- Artifact
Digest Error - Failure while producing a deterministic artifact digest.
- Artifact
Digest Kind - Artifact family included in the integrity-digest domain.
- Asset
Error - Project asset loading or validation failure.
- Config
Error - Configuration loading, parsing, validation, or serialization failure.
- Directory
Identity Error Kind - Stable reason a filesystem identity operation was rejected.
- Directory
Identity Operation - Filesystem operation that failed while capturing an object identity.
- Naming
Error - Project or application identifier validation failure.
- Network
Mode - Application network policy.
- Orientation
- Supported screen orientation policy.
- Regular
File Stream Error Kind - Stable class of a retained regular-file stream inspection failure.
- Target
Platform - Mobile platform generated for an application.
- Theme
- Application color theme preference.
Constants§
- CONFIG_
SCHEMA_ VERSION - Current stable
ferry.tomlschema version.
Functions§
- derive_
project_ names - Validate and derive all project names without touching the filesystem.
- digest_
artifact - Hash a complete APK or Apple application tree with stable path ordering and framing.
- directory_
identity_ from_ file - Capture a directory identity from an already-retained file object.
- regular_
file_ identity_ from_ file - Capture a single-link regular-file identity from an already-retained file object.
- validate_
application_ identifier - Validate the conservative intersection of Android application IDs and Apple bundle IDs.
- verify_
directory_ identity - Reopen an absolute path without following its final component and require exact identity.
- verify_
regular_ file_ has_ no_ named_ streams - Verify that a retained regular-file handle exposes only its unnamed default data stream.
- verify_
regular_ file_ identity - Reopen an absolute path without following its final component and require exact file identity.