Struct SymbolId 

pub struct SymbolId(/* private fields */);

The identity of a symbol within its Object: its position in Object::symbols.

Ids are dense, starting at zero in the order symbols were added.

Examples

use object_lang::{Architecture, Object, Symbol};

let mut obj = Object::relocatable(Architecture::X86_64);
let puts = obj.add_symbol(Symbol::undefined("puts"));
assert_eq!(obj.symbols()[puts.index()].name, "puts");

Implementations

impl SymbolId

pub const fn new(index: u32) -> Self

The id of the symbol at position index in Object::symbols. As with SectionId::new, an id that names no symbol is caught by Object::validate.

Examples

use object_lang::{Architecture, Object, Symbol, SymbolId};

let mut obj = Object::relocatable(Architecture::X86_64);
let exit = obj.add_symbol(Symbol::undefined("exit"));
assert_eq!(SymbolId::new(0), exit);

pub const fn index(self) -> usize

The position of the symbol in Object::symbols.

Examples

use object_lang::{Architecture, Object, Symbol};

let mut obj = Object::relocatable(Architecture::X86_64);
let first = obj.add_symbol(Symbol::undefined("a"));
assert_eq!(first.index(), 0);

Trait Implementations

impl Clone for SymbolId

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SymbolId

impl Debug for SymbolId

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

Formats the value using the given formatter.

impl Eq for SymbolId

impl Hash for SymbolId

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 SymbolId

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for SymbolId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SymbolId

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for SymbolId