Struct FerryConfig 

pub struct FerryConfig {
    pub schema_version: u32,
    pub platforms: Vec<TargetPlatform>,
    pub app: AppConfig,
    pub android: AndroidConfig,
    pub ios: IosConfig,
    pub capabilities: CapabilitiesConfig,
    pub permissions: PermissionsConfig,
    pub extensions: ExtensionsConfig,
}

Complete, versioned ferry.toml document.

Fields

schema_version: u32

Configuration schema used by this file.

platforms: Vec<TargetPlatform>

Platforms generated and validated for this project.

app: AppConfig

Application identity and presentation settings.

android: AndroidConfig

Android build settings.

ios: IosConfig

Apple platform build settings.

capabilities: CapabilitiesConfig

Runtime capabilities compiled into the application.

permissions: PermissionsConfig

Runtime permissions with required user-facing purpose text.

extensions: ExtensionsConfig

Platform extension targets generated with the application.

Implementations

impl FerryConfig

pub fn starter(name: impl Into<String>, identifier: impl Into<String>) -> Self

Create a configuration with starter-friendly defaults.

pub fn parse(source: &str) -> Result<Self, ConfigError>

Parse a strict TOML document.

Errors

Returns ConfigError::Parse when the document is malformed or contains unknown fields.

pub fn load(path: &Utf8Path) -> Result<Self, ConfigError>

Read and validate a configuration file.

Errors

Returns an I/O, parse, or semantic-validation error.

pub fn to_pretty_toml(&self) -> Result<String, ConfigError>

Serialize a deterministic, human-readable TOML document.

Errors

Returns ConfigError::Serialize if the configuration cannot be encoded.

pub fn json_schema() -> Result<String, ConfigError>

Return the stable JSON Schema for editor integration.

Errors

Returns ConfigError::Schema if schema serialization fails.

pub fn validate(&self) -> Vec<ValidationIssue>

Return every semantic validation issue rather than stopping at the first one.

pub fn validate_or_error(&self) -> Result<(), ConfigError>

Fail when semantic validation reports any issue.

Errors

Returns ConfigError::Validation containing every semantic issue.

Trait Implementations

impl Clone for FerryConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FerryConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FerryConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for FerryConfig

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.

impl PartialEq for FerryConfig

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for FerryConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FerryConfig