Enum Arch

#[non_exhaustive]
#[repr(u32)]
pub enum Arch {
    Unknown = 0,
    X86 = 101,
    X86Unknown = 199,
    Amd64 = 201,
    Amd64h = 202,
    Amd64Unknown = 299,
    Arm = 301,
    ArmV5 = 302,
    ArmV6 = 303,
    ArmV6m = 304,
    ArmV7 = 305,
    ArmV7f = 306,
    ArmV7s = 307,
    ArmV7k = 308,
    ArmV7m = 309,
    ArmV7em = 310,
    ArmUnknown = 399,
    Arm64 = 401,
    Arm64V8 = 402,
    Arm64e = 403,
    Arm64Unknown = 499,
    Ppc = 501,
    Ppc64 = 601,
    Mips = 701,
    Mips64 = 801,
    Arm64_32 = 901,
    Arm64_32V8 = 902,
    Arm64_32Unknown = 999,
    Wasm32 = 1_001,
}

An enumeration of CPU architectures and variants.

The architectues are grouped into families, which can be retrieved by cpu_family. There are *Unknown variants for each architecture to maintain forward-compatibility. This allows to support architectures where the family is known but the subtype is not.

Each architecture has a canonical name, returned by Arch::name. Likewise, architectures can be parsed from their string names. In addition to that, in some cases aliases are supported. For instance, "x86" is aliased as "i386".

This enumeration is represented as u32 for C-bindings and lowlevel APIs. The values are grouped by CPU family for forward compatibility.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unknown = 0

X86 = 101

X86Unknown = 199

Amd64 = 201

Amd64h = 202

Amd64Unknown = 299

Arm = 301

ArmV5 = 302

ArmV6 = 303

ArmV6m = 304

ArmV7 = 305

ArmV7f = 306

ArmV7s = 307

ArmV7k = 308

ArmV7m = 309

ArmV7em = 310

ArmUnknown = 399

Arm64 = 401

Arm64V8 = 402

Arm64e = 403

Arm64Unknown = 499

Ppc = 501

Ppc64 = 601

Mips = 701

Mips64 = 801

Arm64_32 = 901

Arm64_32V8 = 902

Arm64_32Unknown = 999

Wasm32 = 1_001

Implementations

impl Arch

pub fn from_u32(val: u32) -> Arch

Creates an Arch from its u32 representation.

Returns Arch::Unknown for all unknown values.

Examples

use symbolic_common::Arch;

// Will print "X86"
println!("{:?}", Arch::from_u32(101));

pub fn cpu_family(self) -> CpuFamily

Returns the CPU family of the CPU architecture.

Examples

use symbolic_common::Arch;

// Will print "Intel32"
println!("{:?}", Arch::X86.cpu_family());

pub fn name(self) -> &'static str

Returns the canonical name of the CPU architecture.

This follows the Apple conventions for naming architectures. For instance, Intel 32-bit architectures are canonically named "x86", even though "i386" would also be a valid name.

For architectures with variants or subtypes, that subtype is encoded into the name. For instance the ARM v7-M architecture is named with a full `“armv7m”.

Examples

use symbolic_common::Arch;

// Will print "x86"
println!("{}", Arch::X86.name());

pub fn well_known(self) -> bool

Returns whether this architecture is well-known.

This is trivially true for all architectures other than the *Unknown variants.

Examples

use symbolic_common::Arch;

assert!(Arch::X86.well_known());
assert!(!Arch::X86Unknown.well_known());

Trait Implementations

impl Clone for Arch

fn clone(&self) -> Arch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Arch

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

Formats the value using the given formatter.

impl Default for Arch

fn default() -> Arch

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Arch

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Arch

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

Formats the value using the given formatter.

impl FromStr for Arch

type Err = UnknownArchError

The associated error which can be returned from parsing.

fn from_str(string: &str) -> Result<Arch, UnknownArchError>

Parses a string s to return a value of this type.

impl Hash for Arch

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 Arch

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Arch

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Arch

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Arch

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Arch

impl Eq for Arch

impl StructuralPartialEq for Arch