Struct AddressRange 

pub struct AddressRange {
    pub start: u64,
    pub end: u64,
}

A half-open virtual-address range, [start, end).

Addresses are the unslid virtual addresses of the image the data describes, so a runtime address must have its load bias removed before it is compared against a range. See docs::symbolication.

An empty range is legal and means a function whose size the producer did not know. Self::contains reports false for every address in that case, but address lookup still resolves such a function, for addresses from its start up to the next function.

use gsym::AddressRange;

let range = AddressRange::new(0x1000, 0x1020);
assert_eq!(range.size(), 0x20);
assert!(range.contains(0x1000));
assert!(!range.contains(0x1020));

// Endpoints are not checked on construction.
let reversed = AddressRange::new(0x20, 0x10);
assert!(!reversed.is_valid());
assert_eq!(reversed.size(), 0);
assert!(reversed.is_empty());

Fields

start: u64

Inclusive start address.

end: u64

Exclusive end address.

Implementations

impl AddressRange

pub const fn new(start: u64, end: u64) -> Self

Creates a range without validating endpoint order.

pub const fn size(self) -> u64

Returns the range width, or zero for reversed endpoints.

pub const fn is_valid(self) -> bool

Returns whether the start is less than or equal to the end.

pub const fn is_empty(self) -> bool

Returns whether the range covers no addresses, including reversed ones.

This is defined as Self::size being zero, so it is also true for the reversed endpoints Self::is_valid rejects: such a range covers nothing, and Self::contains reports false for every address in it.

pub const fn contains(self, address: u64) -> bool

Returns whether address lies in this valid half-open range.

pub const fn contains_range(self, other: Self) -> bool

Returns whether this valid range fully contains other.

Trait Implementations

impl Clone for AddressRange

fn clone(&self) -> AddressRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AddressRange

impl Debug for AddressRange

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

Formats the value using the given formatter.

impl Default for AddressRange

fn default() -> AddressRange

Returns the “default value” for a type.

impl Eq for AddressRange

impl Hash for AddressRange

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 AddressRange

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for AddressRange

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