Struct evegfx::memory::Ptr

pub struct Ptr<R: MemoryRegion> { /* fields omitted */ }

A pointer to a memory address within a particular memory region identified by type parameter R.

Pointers are parameterized by memory region so that other parts of this library which consume pointers can statically constrain what memory regions they are able to refer to.

Implementations

impl<R: MemoryRegion> Ptr<R>

General API for pointers across all memory regions.

pub fn new(offset: u32) -> Self

Constructs a new pointer from the given raw address.

Note that a pointer always belongs to a memory region, but there's no argument here to select one. Instead, we typically rely on type inference to select one, by using the result in a context which implies a particular memory region.

The given offset is interpreted as an offset into the selected memory region, modulo the region length. See MemoryRegion::ptr for more information.

pub fn to_raw(self) -> u32

Returns the absolute address of the pointer.

pub fn to_raw_offset(self) -> u32

Returns the offset of the pointer relative to its containing memory region.

pub fn slice_length(self, length: u32) -> Slice<R>

Returns a slice whose base address is the pointer and whose length is given as an argument.

impl<R: MemoryRegion + HostAccessible> Ptr<R>

pub fn build_spi_write_header(self, into: &mut [u8; 3])

Write the three bytes needed to form a "write memory" header for the address into the given bytes. This is a helper for physical implementations that need to construct a message buffer to transmit to the real chip, e.g. via SPI.

pub fn build_spi_read_header(self, into: &mut [u8; 4])

Write the four bytes needed to form a "read memory" header for the address into the given bytes. This is a helper for physical implementations that need to construct a message buffer to transmit to the real chip, e.g. via SPI.

Trait Implementations

impl<R: MemoryRegion> Add<i32> for Ptr<R>

type Output = Self

The resulting type after applying the + operator.

fn add(self, offset: i32) -> Self

Performs the + operation.

impl<R: MemoryRegion> Add<u32> for Ptr<R>

type Output = Self

The resulting type after applying the + operator.

fn add(self, offset: u32) -> Self

Performs the + operation.

impl<R: MemoryRegion> AddAssign<i32> for Ptr<R>

fn add_assign(&mut self, offset: i32)

Performs the += operation.

impl<R: MemoryRegion> AddAssign<u32> for Ptr<R>

fn add_assign(&mut self, offset: u32)

Performs the += operation.

impl<R: Clone + MemoryRegion> Clone for Ptr<R>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Copy + MemoryRegion> Copy for Ptr<R>

impl<R: MemoryRegion> Debug for Ptr<R>

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

Formats the value using the given formatter.

impl<R: MemoryRegion> Display for Ptr<R>

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

Formats the value using the given formatter.

impl<R: MemoryRegion> Eq for Ptr<R>

impl<R: MemoryRegion> Ord for Ptr<R>

fn cmp(&self, other: &Ptr<R>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<R1: MemoryRegion, R2: MemoryRegion<Model = R1::Model>> PartialEq<Ptr<R2>> for Ptr<R1>

fn eq(&self, other: &Ptr<R2>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<R1: MemoryRegion, R2: MemoryRegion<Model = R1::Model>> PartialOrd<Ptr<R2>> for Ptr<R1>

fn partial_cmp(&self, other: &Ptr<R2>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<R: MemoryRegion> Sub<i32> for Ptr<R>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, offset: i32) -> Self

Performs the - operation.

impl<R: MemoryRegion> Sub<u32> for Ptr<R>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, offset: u32) -> Self

Performs the - operation.

impl<R: MemoryRegion> SubAssign<i32> for Ptr<R>

fn sub_assign(&mut self, offset: i32)

Performs the -= operation.

impl<R: MemoryRegion> SubAssign<u32> for Ptr<R>

fn sub_assign(&mut self, offset: u32)

Performs the -= operation.