Skip to main content

CListHead

kernel::interop::list

Struct CListHead

pub struct CListHead { /* private fields */ }

Expand description

FFI wrapper for a C list_head object used in intrusive linked lists.

§Invariants

The underlying list_head is initialized with valid non-NULL next/prev pointers.

Implementations§

impl CListHead

pub fn project<'this>(self: Pin<&'this mut Self>) -> Projection<'this>

Pin-projects all fields of Self.

These fields are structurally pinned:

inner

These fields are not structurally pinned:

pub fn with_project<'this, R>( self: Pin<&'this mut Self>, f: impl FnOnce(ProjectionLt<'this>) -> R, ) -> R

Pin-projects all fields of Self with proper lifetime.

These fields are structurally pinned:

inner

These fields are not structurally pinned:

pub fn with_project_ref<'this, R>( self: Pin<&'this Self>, f: impl FnOnce(ProjectionRef<'this>) -> R, ) -> R

Pin-projects all fields of Self from a shared reference with proper lifetime.

These fields are structurally pinned:

inner

These fields are not structurally pinned:

impl CListHead

pub unsafe fn from_raw<'a>(ptr: *mut list_head) -> &'a Self

Create a &CListHead reference from a raw list_head pointer.

§Safety

ptr must be a valid pointer to an initialized list_head (e.g. via INIT_LIST_HEAD()), with valid non-NULL next/prev pointers.
ptr must remain valid for the lifetime 'a.
The list and all linked list_head nodes must not be modified from anywhere for the lifetime 'a, unless done so via any CListHead APIs.

pub fn as_raw(&self) -> *mut list_head

Get the raw list_head pointer.

pub fn next(&self) -> &Self

Get the next CListHead in the list.

pub fn is_linked(&self) -> bool

Check if this node is linked in a list (not isolated).

pub fn new() -> impl PinInit<Self>

Returns a pin-initializer for the list head.

Trait Implementations§

impl Eq for CListHead

impl HasPinData for CListHead

type PinData = __ThePinData

fn __pin_data(_: InitData<Self>) -> Self::PinData

impl PartialEq for CListHead

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

impl Send for CListHead

impl Sync for CListHead

Auto Trait Implementations§

impl !Freeze for CListHead

impl !RefUnwindSafe for CListHead

impl !UnsafeUnpin for CListHead

impl UnwindSafe for CListHead

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,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Init<T> for T

fn chain<F>(self, f: F) -> ChainInit<Self, F, T, E>
where F: FnOnce(&mut T) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more

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

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<S, T> IntoSafeCast<T> for S
where T: FromSafeCast<S>,

fn into_safe_cast(self) -> T

Convert self into a T. This operation is guaranteed to be lossless.

impl<S, T> IntoSafeCastArch<T> for S
where T: FromSafeCastArch<S>,

fn into_safe_cast_arch(self) -> T

Convert self into a T. This operation is guaranteed to be lossless.

impl<T> KnownSize for T

const MIN_SIZE: usize = const MIN_SIZE: usize = size_of::<T>();

Minimum size of this type known at compile-time.

const MIN_ALIGN: Alignment = const MIN_ALIGN: Alignment = Alignment::of::<T>();

Minimum alignment of this type known at compile-time.

fn size(_: *const T) -> usize

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

impl<T> PinInit<T> for T

unsafe fn __init(self, slot: *mut T) -> Result<(), !>

Initializes slot. Read more

fn pin_chain<F>(self, f: F) -> ChainPinInit<Self, F, T, E>
where F: FnOnce(Pin<&mut T>) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

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.

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

Performs the conversion.

impl<T, U, const N: u32> TryIntoBounded<T, N> for U
where T: Integer, U: TryInto<T>,

fn try_into_bounded(self) -> Option<Bounded<T, N>>

Attempts to convert self into a Bounded using N bits. Read more