Skip to main content

DebugSymbols

Struct DebugSymbols 

Source
pub struct DebugSymbols { /* private fields */ }
Expand description

Provides support for debug symbols to BPXSD object.

Implementations§

Source§

impl DebugSymbols

Source

pub fn new() -> DebugSymbols

Creates a new DebugSymbols.

Source

pub fn lookup(&self, hash: u64) -> Option<&str>

Performs a lookup for a given hash value in this symbol list. Returns None if the symbol does not exist.

§Arguments
  • hash: the hash for which to search the symbol name.

returns: Option<&str>

§Examples
use bpx::sd::DebugSymbols;
use bpx::utils::hash;

let symbols = DebugSymbols::new();
assert!(symbols.lookup(hash("Test")).is_none());
Source

pub fn push(&mut self, symbol: &str)

Pushes a new symbol in this symbol list.

§Arguments
  • symbol: the name of the symbol to push.
§Examples
use bpx::sd::DebugSymbols;
use bpx::utils::hash;

let mut symbols = DebugSymbols::new();
symbols.push("Test");
assert!(symbols.lookup(hash("Test")).is_some());
Source

pub fn write(&self, obj: &mut Object)

Attach this symbol list to a BPXSD object.

§Arguments
  • obj: the object to attach debug information to.
§Examples
use bpx::sd::{DebugSymbols, Object};
use bpx::utils::hash;

let mut symbols = DebugSymbols::new();
symbols.push("Test");
assert!(symbols.lookup(hash("Test")).is_some());
let mut obj = Object::new();
symbols.write(&mut obj);
assert!(obj.get("__debug__").is_some());
Source

pub fn read(obj: &Object) -> Result<DebugSymbols>

Attempts to read debug information from a BPXSD object.

§Arguments
  • obj: the object to read debug information from.

returns: Result<DebugSymbols, Error>

§Errors

An Error is returned in case the object does not provide debug information or if the debug information could not be read.

§Examples
use bpx::sd::{DebugSymbols, Object};
use bpx::utils::hash;

let mut symbols = DebugSymbols::new();
symbols.push("Test");
let mut obj = Object::new();
symbols.write(&mut obj);
let symbols1 = DebugSymbols::read(&obj).unwrap();
assert!(symbols1.lookup(hash("Test")).is_some());
use bpx::sd::{DebugSymbols, Object};

let mut obj = Object::new();
DebugSymbols::read(&obj).unwrap();

Trait Implementations§

Source§

impl Clone for DebugSymbols

Source§

fn clone(&self) -> DebugSymbols

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.