Struct r3_core::kernel::hunk::Hunk

source · [−]

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

Expand description

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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

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

const INIT: Self

The default value.

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

Auto Trait Implementations

impl<System> RefUnwindSafe for Hunk<System> where
System: RefUnwindSafe,

impl<System> Send for Hunk<System> where
System: Send,

impl<System> Sync for Hunk<System> where
System: Sync,

impl<System> Unpin for Hunk<System> where
System: Unpin,

impl<System> UnwindSafe for Hunk<System> where
System: UnwindSafe,

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · 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.

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.