Enum symbolic_common::Arch

#[repr(u32)]
#[non_exhaustive]pub enum Arch {
    Unknown,
    X86,
    X86Unknown,
    Amd64,
    Amd64h,
    Amd64Unknown,
    Arm,
    ArmV5,
    ArmV6,
    ArmV6m,
    ArmV7,
    ArmV7f,
    ArmV7s,
    ArmV7k,
    ArmV7m,
    ArmV7em,
    ArmUnknown,
    Arm64,
    Arm64V8,
    Arm64e,
    Arm64Unknown,
    Ppc,
    Ppc64,
    Mips,
    Mips64,
    Arm64_32,
    Arm64_32V8,
    Arm64_32Unknown,
}

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

X86

X86Unknown

Amd64

Amd64h

Amd64Unknown

Arm

ArmV5

ArmV6

ArmV6m

ArmV7

ArmV7f

ArmV7s

ArmV7k

ArmV7m

ArmV7em

ArmUnknown

Arm64

Arm64V8

Arm64e

Arm64Unknown

Ppc

Ppc64

Mips

Mips64

Arm64_32

Arm64_32V8

Arm64_32Unknown

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 Copy for Arch

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 Display for Arch

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

Formats the value using the given formatter.

impl Eq for Arch

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, 

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.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Arch> for Arch

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Arch> for Arch

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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 StructuralEq for Arch

impl StructuralPartialEq for Arch