Struct r3_core::kernel::hunk::Hunk

pub struct Hunk<System: KernelStatic> { /* private fields */ }

Represents a single hunk in a system.

Hunks are nothing more than static variables defined in a kernel configuration. They come in handy when you are designing a component that can be instantiated by a kernel configuration and wanting each instance to have its own separate state data.

This Hunk is untyped and only contains a starting address. See r3::hunk::Hunk for a type-safe wrapper of Hunk.

Relation to Other Specifications: None. The need for programmatically defining static regions has been traditionally fulfilled by code generation and preprocessor-based composition. The closest thing might be cell internal variables in the component system that comes with the TOPPERS kernels.

Implementations

impl<System: KernelStatic> Hunk<System>

pub const fn define() -> HunkDefiner<System>

Construct a HunkDefiner to define a hunk in a configuration function.

pub const fn offset(self) -> usize

Get the offset of the hunk.

impl<System: KernelStatic> Hunk<System>

pub fn as_ptr(self) -> *mut u8

Get a raw pointer to the hunk’s contents.

Trait Implementations

impl<System: KernelStatic> Clone for Hunk<System>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<System: KernelStatic> Debug for Hunk<System>

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

Formats the value using the given formatter.

impl<System: KernelStatic> Init for Hunk<System>

const INIT: Self = _

The default value.

impl<System: KernelStatic> Copy for Hunk<System>