Struct Composite

pub struct Composite<'btf> {
    pub is_struct: bool,
    /* private fields */
}

A Composite type, which can be one of a Struct or a Union.

Sometimes it’s not useful to distinguish them, in that case, one can use this type to inspect any of them.

Fields

is_struct: bool

Whether this type is a struct.

Implementations

impl Composite<'_>

pub fn is_empty_union(&self) -> bool

Returns whether this composite type is a union {}.

impl<'btf> Composite<'btf>

pub fn is_empty(&self) -> bool

Whether this type has no members

pub fn len(&self) -> usize

How many members this Composite has

pub fn get(&self, index: usize) -> Option<CompositeMember<'btf>>

Get a CompositeMember at a given index

Errors

This function returns None when the index is out of bounds.

pub fn iter( &'btf self, ) -> impl ExactSizeIterator<Item = CompositeMember<'btf>> + 'btf

Returns an iterator over the CompositeMember’s of the Composite

Methods from Deref<Target = BtfType<'btf>>

pub fn type_id(&self) -> TypeId

This type’s type id.

pub fn name(&self) -> Option<&'btf OsStr>

This type’s name.

pub fn kind(&self) -> BtfKind

This type’s kind.

pub fn is_mod(&self) -> bool

Whether this represent’s a modifier.

pub fn is_any_enum(&self) -> bool

Whether this represents any kind of enum.

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

Whether this btf type is core compatible to other.

pub fn is_composite(&self) -> bool

Whether this type represents a composite type (struct/union).

pub fn next_type(&self) -> Option<Self>

If this type implements ReferencesType, returns the type it references.

pub fn skip_mods_and_typedefs(&self) -> Self

Given a type, follows the refering type ids until it finds a type that isn’t a modifier or a BtfKind::Typedef.

See is_mod.

pub fn alignment(&self) -> Result<NonZeroUsize>

Returns the alignment of this type, if this type points to some modifier or typedef, those will be skipped until the underlying type (with an alignment) is found.

See skip_mods_and_typedefs.

Trait Implementations

impl<'btf> Clone for Composite<'btf>

fn clone(&self) -> Composite<'btf>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'btf> Debug for Composite<'btf>

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

Formats the value using the given formatter.

impl<'btf> Deref for Composite<'btf>

type Target = BtfType<'btf>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'btf> From<Struct<'btf>> for Composite<'btf>

fn from(s: Struct<'btf>) -> Self

Converts to this type from the input type.

impl<'btf> From<Union<'btf>> for Composite<'btf>

fn from(s: Union<'btf>) -> Self

Converts to this type from the input type.

impl<'btf> HasSize<'btf> for Composite<'btf>

fn size(&self) -> usize

The size of the described type.

impl<'btf> TryFrom<BtfType<'btf>> for Composite<'btf>

type Error = BtfType<'btf>

The type returned in the event of a conversion error.

fn try_from(t: BtfType<'btf>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'btf> TryFrom<Composite<'btf>> for Struct<'btf>

type Error = Composite<'btf>

The type returned in the event of a conversion error.

fn try_from(value: Composite<'btf>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'btf> TryFrom<Composite<'btf>> for Union<'btf>

type Error = Composite<'btf>

The type returned in the event of a conversion error.

fn try_from(value: Composite<'btf>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'btf> Copy for Composite<'btf>