Struct FunctionId

pub struct FunctionId {
    pub name: Option<String>,
    pub address: Gs2BytecodeAddress,
    /* private fields */
}

Represents the identifier of a function.

Fields

name: Option<String>

The name of the function, if it is not the entry point.

address: Gs2BytecodeAddress

The address of the function in the module.

Implementations

impl FunctionId

pub fn new<S>( index: usize, name: Option<S>, address: Gs2BytecodeAddress, ) -> Self

where S: Into<String>,

Create a new FunctionId.

Arguments

• index: The index of the function in the module.
• name: The name of the function, if it is not the entry point.
• address: The address of the function in the module.

Returns

• A new FunctionId instance.

Example

use gbf_core::function::FunctionId;

let entry = FunctionId::new_without_name(0, 0);
let add = FunctionId::new(1, Some("add"), 0x100);

pub fn new_without_name(index: usize, address: Gs2BytecodeAddress) -> Self

Helper method for creating a FunctionId without a name.

pub fn is_named(&self) -> bool

If the function has a name.

Returns

• true if the function has a name.
• false if the function does not have a name.

Example

use gbf_core::function::FunctionId;

let entry = FunctionId::new_without_name(0, 0);

assert!(entry.is_named());

Trait Implementations

impl Clone for FunctionId

fn clone(&self) -> FunctionId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FunctionId

Display implementation for FunctionId.

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

Display the Function as its name.

impl Hash for FunctionId

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 FunctionId

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

fn eq(&self, other: &FunctionId) -> 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 FunctionId

fn partial_cmp(&self, other: &FunctionId) -> 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 FunctionId

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for FunctionId

impl StructuralPartialEq for FunctionId