Skip to main content

CList

Struct CList 

Source
pub struct CList<T, const OFFSET: usize>(/* private fields */);
Expand description

A typed C linked list with a sentinel head intended for FFI use-cases where a C subsystem manages a linked list that Rust code needs to read. Generally required only for special cases.

A sentinel head CListHead represents the entire linked list and can be used for iteration over items of type T; it is not associated with a specific item.

The const generic OFFSET specifies the byte offset of the list_head field within the struct that T wraps.

§Invariants

  • The sentinel CListHead has valid non-NULL next/prev pointers.
  • OFFSET is the byte offset of the list_head field within the struct that T wraps.
  • All the list’s list_head nodes have valid non-NULL next/prev pointers.

Implementations§

Source§

impl<T, const OFFSET: usize> CList<T, OFFSET>

Source

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

Create a typed CList reference from a raw sentinel list_head pointer.

§Safety
  • ptr must be a valid pointer to an initialized sentinel 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 nodes must not be concurrently modified for the lifetime 'a.
  • The list must contain items where the list_head field is at byte offset OFFSET.
  • T must be #[repr(transparent)] over the C struct.
Source

pub fn is_empty(&self) -> bool

Check if the list is empty.

Source

pub fn iter(&self) -> CListIter<'_, T, OFFSET>

Create an iterator over typed items.

Auto Trait Implementations§

§

impl<T, const OFFSET: usize> !Freeze for CList<T, OFFSET>

§

impl<T, const OFFSET: usize> !RefUnwindSafe for CList<T, OFFSET>

§

impl<T, const OFFSET: usize> Send for CList<T, OFFSET>
where T: Send,

§

impl<T, const OFFSET: usize> Sync for CList<T, OFFSET>
where T: Sync,

§

impl<T, const OFFSET: usize> !Unpin for CList<T, OFFSET>

§

impl<T, const OFFSET: usize> !UnsafeUnpin for CList<T, OFFSET>

§

impl<T, const OFFSET: usize> UnwindSafe for CList<T, OFFSET>
where T: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Init<T> for T

Source§

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

Initializes slot. Read more
Source§

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
Source§

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

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.

Source§

impl<T> KnownSize for T

Source§

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

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

impl<T> PinInit<T> for T

Source§

unsafe fn __pinned_init(self, slot: *mut T) -> Result<(), Infallible>

Initializes slot. Read more
Source§

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
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

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