Enum apple_codesign::SettingsScope

pub enum SettingsScope {
    Main,
    Path(String),
    MultiArchIndex(usize),
    MultiArchCpuType(CpuType),
    PathMultiArchIndex(String, usize),
    PathMultiArchCpuType(String, CpuType),
}

Denotes the scope for a setting.

Settings have an associated scope defined by this type. This allows settings to apply to exactly what you want them to apply to.

Scopes can be converted from a string representation. The following syntax is recognized:

• @main - Maps to SettingsScope::Main
• @<int> - e.g. @0. Maps to SettingsScope::MultiArchIndex.Index
• @[cpu_type=<int>] - e.g. @[cpu_type=7]. Maps to SettingsScope::MultiArchCpuType.
• @[cpu_type=<string>] - e.g. @[cpu_type=x86_64]. Maps to SettingsScope::MultiArchCpuType for recognized string values (see below).
• <string> - e.g. path/to/file. Maps to SettingsScope::Path.
• <string>@<int> - e.g. path/to/file@0. Maps to SettingsScope::PathMultiArchIndex.
• <string>@[cpu_type=<int>] - e.g. path/to/file@[cpu_type=7]. Maps to SettingsScope::PathMultiArchCpuType.
• <string>@[cpu_type=<string>] - e.g. path/to/file@[cpu_type=arm64]. Maps to SettingsScope::PathMultiArchCpuType for recognized string values (see below).

Recognized cpu_type String Values

The following cpu_type= string values are recognized:

• arm -> CPU_TYPE_ARM
• arm64 -> CPU_TYPE_ARM64
• arm64_32 -> CPU_TYPE_ARM64_32
• x86_64 -> CPU_TYPE_X86_64

Variants

Main

The main entity being signed.

Can be a Mach-O file, a bundle, or any other primitive this crate supports signing.

When signing a bundle or any primitive with nested elements (such as a fat/universal Mach-O binary), settings can propagate to nested elements.

Path(String)

Filesystem path.

Can refer to a Mach-O file, a nested bundle, or any other filesystem based primitive that can be traversed into when performing nested signing.

The string value refers to the filesystem relative path of the entity relative to the main entity being signed.

MultiArchIndex(usize)

A single Mach-O binary within a fat/universal Mach-O binary.

The binary to operate on is defined by its 0-based index within the fat/universal Mach-O container.

MultiArchCpuType(CpuType)

A single Mach-O binary within a fat/universal Mach-O binary.

The binary to operate on is defined by its CPU architecture.

PathMultiArchIndex(String, usize)

Combination of SettingsScope::Path and SettingsScope::MultiArchIndex.

This refers to a single Mach-O binary within a fat/universal binary at a given relative path.

PathMultiArchCpuType(String, CpuType)

Combination of SettingsScope::Path and SettingsScope::MultiArchCpuType.

This refers to a single Mach-O binary within a fat/universal binary at a given relative path.

Trait Implementations

impl AsRef<SettingsScope> for SettingsScope

fn as_ref(&self) -> &SettingsScope

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SettingsScope

fn clone(&self) -> SettingsScope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SettingsScope

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

Formats the value using the given formatter.

impl Display for SettingsScope

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

Formats the value using the given formatter.

impl Hash for SettingsScope

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SettingsScope

fn cmp(&self, other: &SettingsScope) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<SettingsScope> for SettingsScope

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<SettingsScope> for SettingsScope

fn partial_cmp(&self, other: &SettingsScope) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<&str> for SettingsScope

type Error = AppleCodesignError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for SettingsScope

impl StructuralEq for SettingsScope

impl StructuralPartialEq for SettingsScope