Struct r3_core::hunk::Hunk

pub struct Hunk<System, T: ?Sized> { /* private fields */ }

Represents a single typed 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 type is implemented on top of r3::kernel::Hunk, the untyped hunk type.

Implementations

impl<System: KernelBase + KernelStatic, T: ?Sized> Hunk<System, T>

pub const fn define() -> HunkDefiner<System, T, DefaultInitTag>

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

impl<System, T: ?Sized> Hunk<System, T>

pub const unsafe fn transmute<U>(self) -> Hunk<System, U>

Reinterpret the hunk as another type.

Safety

• Similarly to core::mem::transmute, this is incredibly unsafe.
• The byte offset must be valid for the destination type.

pub const unsafe fn wrapping_offset(self, count: isize) -> Selfwhere
    T: Sized,

Calculate the offset from the hunk.

Safety

• The resulting hunk may point to memory that the caller is not supposed to access.

impl<System: KernelBase + KernelStatic, T: ?Sized> Hunk<System, T>

pub fn untyped_hunk(this: Self) -> Hunk<System>

Get the untyped hunk.

pub fn as_ptr(this: Self) -> *const T

Get a raw pointer to the hunk’s contents.

pub fn as_bytes_ptr(this: Self) -> *const [u8]

Get a raw pointer to the raw bytes of the hunk.

pub fn as_ref<'a>(this: Self) -> &'a Twhere
    T: 'a,

Get a reference to the hunk’s contents.

pub unsafe fn as_bytes(this: Self) -> &'static [u8]

Get a reference to the raw bytes of the hunk.

Safety

The result might include uninitialized bytes and/or interior mutability, so it might be unsafe to access.

Trait Implementations

impl<System: KernelBase + KernelStatic, T: ?Sized> AsRef<T> for Hunk<System, T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<System, T: ?Sized> Clone for Hunk<System, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<System: KernelBase + KernelStatic, T: Debug + ?Sized> Debug for Hunk<System, T>

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

Formats the value using the given formatter.

impl<System: KernelBase + KernelStatic, T: ?Sized> Deref for Hunk<System, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<System: KernelBase + KernelStatic, T> Init for Hunk<System, [T]>

const INIT: Self = _

The default value.

impl<System: KernelBase + KernelStatic, T: ?Sized> CloneStableDeref for Hunk<System, T>

impl<System, T: ?Sized> Copy for Hunk<System, T>

impl<System, T: ?Sized + Send> Send for Hunk<System, T>

impl<System: KernelBase + KernelStatic, T: ?Sized> StableDeref for Hunk<System, T>

impl<System, T: ?Sized + Sync> Sync for Hunk<System, T>