Struct MacOsConfig 

#[non_exhaustive]
pub struct MacOsConfig {

    pub frameworks: Option<Vec<String>>,
    pub minimum_system_version: Option<String>,
    pub exception_domain: Option<String>,
    pub signing_identity: Option<String>,
    pub signing_certificate: Option<OsString>,
    pub signing_certificate_password: Option<OsString>,
    pub notarization_credentials: Option<MacOsNotarizationCredentials>,
    pub provider_short_name: Option<String>,
    pub entitlements: Option<String>,
    pub info_plist_path: Option<PathBuf>,
    pub embedded_provisionprofile_path: Option<PathBuf>,
    pub embedded_apps: Option<Vec<String>>,
    pub background_app: bool,
}

The macOS configuration.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

frameworks: Option<Vec<String>>

MacOS frameworks that need to be packaged with the app.

Each string can either be the name of a framework (without the .framework extension, e.g. "SDL2"), in which case we will search for that framework in the standard install locations (~/Library/Frameworks/, /Library/Frameworks/, and /Network/Library/Frameworks/), or a path to a specific framework bundle (e.g. ./data/frameworks/SDL2.framework). Note that this setting just makes cargo-packager copy the specified frameworks into the OS X app bundle (under Foobar.app/Contents/Frameworks/); you are still responsible for:

• arranging for the compiled binary to link against those frameworks (e.g. by emitting lines like cargo:rustc-link-lib=framework=SDL2 from your build.rs script)

• embedding the correct rpath in your binary (e.g. by running install_name_tool -add_rpath "@executable_path/../Frameworks" path/to/binary after compiling)

minimum_system_version: Option<String>

A version string indicating the minimum MacOS version that the packaged app supports (e.g. "10.11"). If you are using this config field, you may also want have your build.rs script emit cargo:rustc-env=MACOSX_DEPLOYMENT_TARGET=10.11.

exception_domain: Option<String>

The exception domain to use on the macOS .app package.

This allows communication to the outside world e.g. a web server you’re shipping.

signing_identity: Option<String>

Code signing identity.

This is typically of the form: "Developer ID Application: TEAM_NAME (TEAM_ID)".

signing_certificate: Option<OsString>

Codesign certificate (base64 encoded of the p12 file).

Note: this field cannot be specified via a config file or Cargo package metadata.

signing_certificate_password: Option<OsString>

Password of the codesign certificate.

Note: this field cannot be specified via a config file or Cargo package metadata.

notarization_credentials: Option<MacOsNotarizationCredentials>

Notarization authentication credentials.

Note: this field cannot be specified via a config file or Cargo package metadata.

provider_short_name: Option<String>

Provider short name for notarization.

entitlements: Option<String>

Path to the entitlements.plist file.

info_plist_path: Option<PathBuf>

Path to the Info.plist file for the package.

embedded_provisionprofile_path: Option<PathBuf>

Path to the embedded.provisionprofile file for the package.

embedded_apps: Option<Vec<String>>

Apps that need to be packaged within the app.

background_app: bool

Whether this is a background application. If true, the app will not appear in the Dock.

Sets the LSUIElement flag in the macOS plist file.

Implementations

impl MacOsConfig

pub fn new() -> Self

Creates a new MacOsConfig.

pub fn frameworks<I, S>(self, frameworks: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

MacOS frameworks that need to be packaged with the app.

Each string can either be the name of a framework (without the .framework extension, e.g. "SDL2"), in which case we will search for that framework in the standard install locations (~/Library/Frameworks/, /Library/Frameworks/, and /Network/Library/Frameworks/), or a path to a specific framework bundle (e.g. ./data/frameworks/SDL2.framework). Note that this setting just makes cargo-packager copy the specified frameworks into the OS X app bundle (under Foobar.app/Contents/Frameworks/); you are still responsible for:

• arranging for the compiled binary to link against those frameworks (e.g. by emitting lines like cargo:rustc-link-lib=framework=SDL2 from your build.rs script)

• embedding the correct rpath in your binary (e.g. by running install_name_tool -add_rpath "@executable_path/../Frameworks" path/to/binary after compiling)

pub fn minimum_system_version<S: Into<String>>( self, minimum_system_version: S, ) -> Self

A version string indicating the minimum MacOS version that the packaged app supports (e.g. "10.11"). If you are using this config field, you may also want have your build.rs script emit cargo:rustc-env=MACOSX_DEPLOYMENT_TARGET=10.11.

pub fn exception_domain<S: Into<String>>(self, exception_domain: S) -> Self

The exception domain to use on the macOS .app package.

This allows communication to the outside world e.g. a web server you’re shipping.

pub fn signing_identity<S: Into<String>>(self, signing_identity: S) -> Self

Code signing identity.

pub fn provider_short_name<S: Into<String>>( self, provider_short_name: S, ) -> Self

Provider short name for notarization.

pub fn entitlements<S: Into<String>>(self, entitlements: S) -> Self

Path to the entitlements.plist file.

pub fn info_plist_path<S: Into<PathBuf>>(self, info_plist_path: S) -> Self

Path to the Info.plist file for the package.

pub fn embedded_provisionprofile_path<S: Into<PathBuf>>( self, embedded_provisionprofile_path: S, ) -> Self

Path to the embedded.provisionprofile file for the package.

pub fn embedded_apps<I, S>(self, embedded_apps: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Apps that need to be packaged within the app.

Trait Implementations

impl Clone for MacOsConfig

fn clone(&self) -> MacOsConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MacOsConfig

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

Formats the value using the given formatter.

impl Default for MacOsConfig

fn default() -> MacOsConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MacOsConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MacOsConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.