Struct stm32wlxx_hal::flash::Page

pub struct Page { /* private fields */ }

Page address.

Implementations

impl Page

pub const SIZE: usize = 2_048usize

Page size in bytes.

pub const unsafe fn from_index_unchecked(idx: u8) -> Self

Create a page address from an index without checking bounds.

Safety

1. The idx argument must be a valid page number, less than the value returned by num_pages.

Example

use stm32wlxx_hal::flash::Page;

let page0 = unsafe { Page::from_index_unchecked(0) };

pub fn from_index(idx: u8) -> Option<Self>

Create a page address from an index.

Returns None if the value index is greater than the index of the last page, for example 0x7F (page 127) on the STM32WLE5.

Example

use stm32wlxx_hal::flash::Page;

assert!(Page::from_index(8).is_some());
assert!(Page::from_index(128).is_none());

pub fn from_byte_offset(offset: usize) -> Option<Self>

Create a page address from an offset from the base of the flash memory.

Returns None if the address is out of bounds, or not page aligned.

Example

use stm32wlxx_hal::flash::Page;

assert_eq!(Page::from_byte_offset(0), Page::from_index(0));
assert_eq!(Page::from_byte_offset(2048), Page::from_index(1));
assert!(Page::from_byte_offset(2047).is_none());
assert!(Page::from_byte_offset(usize::MAX).is_none());

pub fn from_addr(addr: usize) -> Option<Self>

Create a page address from an absolute address.

Returns None if the address is out of bounds, or not page aligned.

Example

use stm32wlxx_hal::flash::Page;

assert_eq!(Page::from_addr(0x0800_0000), Page::from_index(0));
assert_eq!(Page::from_addr(0x0800_0800), Page::from_index(1));
assert!(Page::from_addr(0).is_none());
assert!(Page::from_addr(usize::MAX).is_none());
assert!(Page::from_addr(0x0800_0001).is_none());

pub const fn to_index(self) -> u8

Get the page index.

Example

use stm32wlxx_hal::flash::Page;

let page7 = unsafe { Page::from_index_unchecked(7) };
assert_eq!(page7.to_index(), 7);

pub const fn addr(&self) -> usize

Get the page address.

Example

use stm32wlxx_hal::flash::Page;

let page127 = unsafe { Page::from_index_unchecked(127) };
let page0 = unsafe { Page::from_index_unchecked(0) };

assert_eq!(page0.addr(), 0x0800_0000);
assert_eq!(page127.addr(), 0x0803_F800);

pub const fn addr_range(&self) -> Range<usize>

Get the address range of the page.

Example

use core::ops::Range;
use stm32wlxx_hal::flash::Page;

let page0 = unsafe { Page::from_index_unchecked(0) };
assert_eq!(
    page0.addr_range(),
    Range {
        start: 0x0800_0000,
        end: 0x0800_0800
    }
);

Trait Implementations

impl Clone for Page

fn clone(&self) -> Page

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Page

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

Formats the value using the given formatter.

impl From<Page> for AlignedAddr

fn from(page: Page) -> Self

Converts to this type from the input type.

impl Hash for Page

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 Page

fn cmp(&self, other: &Page) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Page

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Page

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

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

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

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

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

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

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

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

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 Copy for Page

impl Eq for Page

impl StructuralEq for Page

impl StructuralPartialEq for Page