Struct r3::hunk::Hunk

pub struct Hunk<System, T>where
    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, T> Hunk<System, T>where System: KernelBase + KernelStatic<System>, T: ?Sized,

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

Available on crate feature sync only.

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

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

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

Available on crate feature sync only.

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) -> Hunk<System, T>

Available on crate feature sync only.

Calculate the offset from the hunk.

Safety

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

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

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

Available on crate feature sync only.

Get the untyped hunk.

pub fn as_ptr(this: Hunk<System, T>) -> *const T

Available on crate feature sync only.

Get a raw pointer to the hunk’s contents.

pub fn as_bytes_ptr(this: Hunk<System, T>) -> *const [u8]

Available on crate feature sync only.

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

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

Available on crate feature sync only.

Get a reference to the hunk’s contents.

pub unsafe fn as_bytes(this: Hunk<System, T>) -> &'static [u8]

Available on crate feature sync only.

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, T> AsRef<T> for Hunk<System, T>where System: KernelBase + KernelStatic<System>, T: ?Sized,

fn as_ref(&self) -> &T

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

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

fn clone(&self) -> Hunk<System, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<Hunk<System, T> as Deref>::Target

Dereferences the value.

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

const INIT: Hunk<System, [T]> = Self{ offset: slice_from_raw_parts_mut(core::ptr::null_mut(), 0), _phantom: PhantomData,}

The default value.

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

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

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

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

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