Ptr

Struct Ptr 

Source
pub struct Ptr<T: ?Sized = ()> { /* private fields */ }
Expand description

Typed virtual address.

Implementations§

Source§

impl<T: ?Sized> Ptr<T>

Source

pub const NULL: Ptr<T>

Null pointer constant.

Source

pub const fn null() -> Ptr<T>

Creates a null pointer.

Source

pub const fn is_null(self) -> bool

Returns true if the pointer is null.

Source

pub const fn member(va: Va, offset: u32) -> Ptr<T>

Constructs a pointer with an offset.

Source

pub const fn cast<U: ?Sized>(self) -> Ptr<U>

Casts the pointer to a different type keeping the pointer address fixed.

Source

pub const fn offset<U: ?Sized>(self, offset: i32) -> Ptr<U>

Offsets and casts the pointer.

Because the type of the current and the target may be unrelated, this is a byte offset.

§Examples
use pelite::pe64::Ptr;

#[repr(C)]
struct Composite {
	int: i32,
	float: f32,
}

let p: Ptr<Composite> = Ptr::from(0x2000);
let target = p.offset::<f32>(4);

assert_eq!(target, Ptr::from(0x2004));
Source

pub const fn into_raw(self) -> Va

Returns the raw integer, type ascription helper.

Source§

impl<T> Ptr<[T]>

Source

pub const fn decay(self) -> Ptr<T>

Decays the pointer from [T] to T.

Source

pub const fn at(self, i: usize) -> Ptr<T>

Pointer arithmetic, gets the pointer of an element at the specified index.

Trait Implementations§

Source§

impl<T: ?Sized> AsMut<u32> for Ptr<T>

Source§

fn as_mut(&mut self) -> &mut Va

Converts this type into a mutable reference of the (usually inferred) input type.
Source§

impl<T: ?Sized> AsRef<u32> for Ptr<T>

Source§

fn as_ref(&self) -> &Va

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl<T: ?Sized> Clone for Ptr<T>

Source§

fn clone(&self) -> Ptr<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: ?Sized> Debug for Ptr<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: ?Sized> Default for Ptr<T>

Source§

fn default() -> Ptr<T>

Returns the “default value” for a type. Read more
Source§

impl<T: ?Sized> Display for Ptr<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: ?Sized> From<Ptr<T>> for Va

Source§

fn from(ptr: Ptr<T>) -> Va

Converts to this type from the input type.
Source§

impl<T: ?Sized> From<u32> for Ptr<T>

Source§

fn from(va: Va) -> Ptr<T>

Converts to this type from the input type.
Source§

impl<T: ?Sized> Hash for Ptr<T>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<T: ?Sized> LowerHex for Ptr<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: ?Sized> Ord for Ptr<T>

Source§

fn cmp(&self, rhs: &Ptr<T>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl<T: ?Sized> PartialEq for Ptr<T>

Source§

fn eq(&self, rhs: &Ptr<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T: ?Sized> PartialOrd for Ptr<T>

Source§

fn partial_cmp(&self, rhs: &Ptr<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<T: ?Sized> UpperHex for Ptr<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: ?Sized> Copy for Ptr<T>

Source§

impl<T: ?Sized> Eq for Ptr<T>

Source§

impl<T: ?Sized> Pod for Ptr<T>
where Ptr<T>: 'static,

Auto Trait Implementations§

§

impl<T> Freeze for Ptr<T>
where T: ?Sized,

§

impl<T> RefUnwindSafe for Ptr<T>
where T: ?Sized,

§

impl<T> Send for Ptr<T>
where T: ?Sized,

§

impl<T> Sync for Ptr<T>
where T: ?Sized,

§

impl<T> Unpin for Ptr<T>
where T: ?Sized,

§

impl<T> UnwindSafe for Ptr<T>
where T: ?Sized,

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> PodMethods for T
where T: Pod + ?Sized,

Source§

fn zeroed() -> T

Returns a zero-initialized instance of the type.
Source§

fn as_bytes(&self) -> &[u8]

Returns the object’s memory as a byte slice.
Source§

fn as_bytes_mut(&mut self) -> &mut [u8]

Returns the object’s memory as a mutable byte slice.
Source§

fn as_data_view(&self) -> &DataView

Returns a data view into the object’s memory.
Source§

fn as_data_view_mut(&mut self) -> &mut DataView

Returns a mutable data view into the object’s memory.
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.