Struct Region 

pub struct Region<const SIZE: usize = 0> { /* private fields */ }

Untyped I/O region.

This type can be used when an I/O region without known type information has a compile-time known minimum size (and a runtime known actual size).

Invariants

• Size of the region is at least as large as the SIZE generic parameter.
• Size of the region is multiple of 4.

Implementations

impl<const SIZE: usize> Region<SIZE>

pub fn ptr_from_raw_parts_mut(base: *mut u8, size: usize) -> *mut Self

Create a raw mutable pointer from given base address and size.

size should be at least as large as the minimum size SIZE, and base and size should be 4-byte aligned to uphold the type invariant.

Just like other methods on raw pointers, it is not unsafe to create a raw pointer that does not uphold the type invariants. However such pointers are not valid.

pub fn ptr_try_from_raw_parts_mut( base: *mut u8, size: usize, ) -> Result<*mut Self>

Create a raw mutable pointer from given base address and size.

The alignment of base is checked, and size is checked against the minimum size specified via const generics.

Trait Implementations

impl<const SIZE: usize> FromBytes for Region<SIZE>

where [u8]: FromBytes,

impl<const SIZE: usize> FromZeros for Region<SIZE>

where [u8]: FromZeros,

fn zero(&mut self)

Overwrites self with zeros.

impl<const SIZE: usize> IntoBytes for Region<SIZE>

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

where Self: FromBytes,

Gets the bytes of this value mutably.

impl<const SIZE: usize, T> IoLoc<Region<SIZE>, T> for ()

where T: FixedRegister,

Allows () to be used as the location parameter of Io::write when passing a FixedRegister value.

type IoType = <T as Register>::Storage

Size (u8, u16, etc) of the I/O performed on the returned offset.

fn offset(self) -> usize

Consumes self and returns the offset of this location.

impl<const SIZE: usize, T> IoLoc<Region<SIZE>, T> for T

where T: FixedRegister,

A FixedRegister carries its location in its type. Thus FixedRegister values can be used as an IoLoc.

type IoType = <T as Register>::Storage

Size (u8, u16, etc) of the I/O performed on the returned offset.

fn offset(self) -> usize

Consumes self and returns the offset of this location.

impl<const SIZE: usize, T> IoLoc<Region<SIZE>, T> for FixedRegisterLoc<T>

where T: FixedRegister,

type IoType = <T as Register>::Storage

Size (u8, u16, etc) of the I/O performed on the returned offset.

fn offset(self) -> usize

Consumes self and returns the offset of this location.

impl<const SIZE: usize, T, B> IoLoc<Region<SIZE>, T> for RelativeRegisterLoc<T, B>

where T: RelativeRegister, B: RegisterBase<T::BaseFamily> + ?Sized,

type IoType = <T as Register>::Storage

Size (u8, u16, etc) of the I/O performed on the returned offset.

fn offset(self) -> usize

Consumes self and returns the offset of this location.

impl<const SIZE: usize, T> IoLoc<Region<SIZE>, T> for RegisterArrayLoc<T>

where T: RegisterArray,

type IoType = <T as Register>::Storage

Size (u8, u16, etc) of the I/O performed on the returned offset.

fn offset(self) -> usize

Consumes self and returns the offset of this location.

impl<const SIZE: usize, T, B> IoLoc<Region<SIZE>, T> for RelativeRegisterArrayLoc<T, B>

where T: RelativeRegisterArray, B: RegisterBase<T::BaseFamily> + ?Sized,

type IoType = <T as Register>::Storage

Size (u8, u16, etc) of the I/O performed on the returned offset.

fn offset(self) -> usize

Consumes self and returns the offset of this location.

impl<const SIZE: usize> IoLoc<Region<SIZE>, u8> for usize

type IoType = u8

Size (u8, u16, etc) of the I/O performed on the returned offset.

fn offset(self) -> usize

Consumes self and returns the offset of this location.

impl<const SIZE: usize> IoLoc<Region<SIZE>, u16> for usize

type IoType = u16

Size (u8, u16, etc) of the I/O performed on the returned offset.

fn offset(self) -> usize

Consumes self and returns the offset of this location.

impl<const SIZE: usize> IoLoc<Region<SIZE>, u32> for usize

type IoType = u32

Size (u8, u16, etc) of the I/O performed on the returned offset.

fn offset(self) -> usize

Consumes self and returns the offset of this location.

impl<const SIZE: usize> IoLoc<Region<SIZE>, u64> for usize

type IoType = u64

Size (u8, u16, etc) of the I/O performed on the returned offset.

fn offset(self) -> usize

Consumes self and returns the offset of this location.

impl<const SIZE: usize> KnownSize for Region<SIZE>

const MIN_SIZE: usize = SIZE

Minimum size of this type known at compile-time.

const MIN_ALIGN: Alignment

Minimum alignment of this type known at compile-time.

fn size(p: *const Self) -> usize

Get the size of an object of this type in bytes, with the metadata of the given pointer.

impl<const SIZE: usize, T> LocatedRegister<Region<SIZE>> for T

where T: FixedRegister,

type Location = FixedRegisterLoc<<T as LocatedRegister<Region<SIZE>>>::Value>

Full location information at which to write the value.

type Value = T

Register value to write.

fn into_io_op(self) -> (FixedRegisterLoc<T>, T)

Consumes self and returns a (location, value) tuple describing a valid I/O write operation.

impl<const SIZE: usize> TryFromBytes for Region<SIZE>

where [u8]: TryFromBytes,