Enum CustomType

#[non_exhaustive]
pub enum CustomType {
    Struct(Struct),
    Opaque(OpaqueStruct),
    Enum(Enum),
}

A type declared inside a Diplomat-annotated module.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Struct(Struct)

A non-opaque struct whose fields will be visible across the FFI boundary.

Opaque(OpaqueStruct)

A struct annotated with [diplomat::opaque] whose fields are not visible.

Enum(Enum)

A fieldless enum.

Implementations

impl CustomType

pub fn name(&self) -> &Ident

Get the name of the custom type, which is unique within a module.

pub fn methods(&self) -> &Vec<Method>

Get the methods declared in impls of the custom type.

pub fn attrs(&self) -> &Attrs

pub fn dtor_name(&self) -> String

The name of the destructor in C

pub fn docs(&self) -> &Docs

Get the doc lines of the custom type.

pub fn all_rust_links(&self) -> impl Iterator<Item = &RustLink> + '_

Get all rust links on this type and its methods

pub fn self_path(&self, in_path: &Path) -> Path

pub fn lifetimes(&self) -> Option<&LifetimeEnv>

Get the lifetimes of the custom type.

Trait Implementations

impl Clone for CustomType

fn clone(&self) -> CustomType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CustomType

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

Formats the value using the given formatter.

impl Hash for CustomType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CustomType

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CustomType

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CustomType

impl StructuralPartialEq for CustomType