Struct symbolic_common::DebugId

#[repr(C, packed)]
pub struct DebugId { /* fields omitted */ }

Unique identifier for debug information files and their debug information.

This type is analogous to CodeId, except that it identifies a debug file instead of the actual library or executable. One some platforms, a DebugId is an alias for a CodeId but the exact rules around this are complex. On Windows, the identifiers are completely different and refer to separate files.

The string representation must be between 33 and 40 characters long and consist of:

1. 36 character hyphenated hex representation of the UUID field
2. 1-16 character lowercase hex representation of the u32 appendix

The debug identifier is compatible to Google Breakpad. Use DebugId::breakpad to get a breakpad string representation of this debug identifier.

Example

use std::str::FromStr;
use debugid::DebugId;

let id = DebugId::from_str("dfb8e43a-f242-3d73-a453-aeb6a777ef75-a")?;
assert_eq!("dfb8e43a-f242-3d73-a453-aeb6a777ef75-a".to_string(), id.to_string());

Methods

impl DebugId

pub fn nil() -> DebugId

Constructs an empty debug identifier, containing only zeros.

pub fn from_uuid(uuid: Uuid) -> DebugId

Constructs a DebugId from its uuid.

pub fn from_parts(uuid: Uuid, appendix: u32) -> DebugId

Constructs a DebugId from its uuid and appendix parts.

pub fn from_guid_age(
    guid: &[u8],
    age: u32
) -> Result<DebugId, ParseDebugIdError>

Constructs a DebugId from a Microsoft little-endian GUID and age.

pub fn from_breakpad(string: &str) -> Result<DebugId, ParseDebugIdError>

Parses a breakpad identifier from a string.

pub fn uuid(&self) -> Uuid

Returns the UUID part of the code module's debug_identifier.

pub fn appendix(&self) -> u32

Returns the appendix part of the code module's debug identifier.

On Windows, this is an incrementing counter to identify the build. On all other platforms, this value will always be zero.

pub fn is_nil(&self) -> bool

Returns whether this identifier is nil, i.e. it consists only of zeros.

pub fn breakpad(&self) -> BreakpadFormat

Returns a wrapper which when formatted via fmt::Display will format a a breakpad identifier.

Trait Implementations

impl Ord for DebugId

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl Copy for DebugId

impl Clone for DebugId

fn clone(&self) -> DebugId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Hash for DebugId

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Eq for DebugId

impl From<Uuid> for DebugId

fn from(uuid: Uuid) -> DebugId

Performs the conversion.

impl From<(Uuid, u32)> for DebugId

fn from(tuple: (Uuid, u32)) -> DebugId

Performs the conversion.

impl PartialOrd<DebugId> for DebugId

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

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

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

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

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

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

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

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

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

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

impl Display for DebugId

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

Formats the value using the given formatter.

impl Debug for DebugId

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

Formats the value using the given formatter.

impl PartialEq<DebugId> for DebugId

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

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

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

This method tests for !=.

impl FromStr for DebugId

type Err = ParseDebugIdError

The associated error which can be returned from parsing.

fn from_str(string: &str) -> Result<DebugId, ParseDebugIdError>

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

impl Default for DebugId

fn default() -> DebugId

Returns the "default value" for a type.