Struct uniffi_bindgen::bindings::swift::gen_swift::Config

pub struct Config {
    cdylib_name: Option<String>,
    module_name: Option<String>,
    ffi_module_name: Option<String>,
    ffi_module_filename: Option<String>,
    generate_module_map: Option<bool>,
    omit_argument_labels: Option<bool>,
    generate_immutable_records: Option<bool>,
    experimental_sendable_value_types: Option<bool>,
    custom_types: HashMap<String, CustomTypeConfig>,
}

Config options for the caller to customize the generated Swift.

Note that this can only be used to control details of the Swift that do not affect the underlying component, since the details of the underlying component are entirely determined by the ComponentInterface.

Fields

cdylib_name: Option<String>

module_name: Option<String>

ffi_module_name: Option<String>

ffi_module_filename: Option<String>

generate_module_map: Option<bool>

omit_argument_labels: Option<bool>

generate_immutable_records: Option<bool>

experimental_sendable_value_types: Option<bool>

custom_types: HashMap<String, CustomTypeConfig>

Implementations

impl Config

pub fn module_name(&self) -> String

The name of the Swift module containing the high-level foreign-language bindings.

pub fn ffi_module_name(&self) -> String

The name of the lower-level C module containing the FFI declarations.

pub fn ffi_module_filename(&self) -> String

The filename stem for the lower-level C module containing the FFI declarations.

pub fn modulemap_filename(&self) -> String

The name of the .modulemap file for the lower-level C module with FFI declarations.

pub fn header_filename(&self) -> String

The name of the .h file for the lower-level C module with FFI declarations.

pub fn cdylib_name(&self) -> String

The name of the compiled Rust library containing the FFI implementation.

pub fn generate_module_map(&self) -> bool

Whether to generate a .modulemap file for the lower-level C module with FFI declarations.

pub fn omit_argument_labels(&self) -> bool

Whether to omit argument labels in Swift function definitions.

pub fn generate_immutable_records(&self) -> bool

Whether to generate immutable records (let instead of var)

pub fn experimental_sendable_value_types(&self) -> bool

Whether to mark value types as ‘Sendable’

Trait Implementations

impl BindingsConfig for Config

fn update_from_ci(&mut self, ci: &ComponentInterface)

Update missing values using the ComponentInterface

fn update_from_cdylib_name(&mut self, cdylib_name: &str)

Update missing values using the dylib file for the main crate, when in library mode.

fn update_from_dependency_configs(&mut self, _config_map: HashMap<&str, &Self>)

Update missing values from config instances from dependent crates

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.