Skip to main content

ArgRole

Enum ArgRole 

Source
pub enum ArgRole {
    SelfPointer,
    WrapperPointer,
    HandlerSync,
    HandlerRetainedBorrowed,
    HandlerRetainedOwned,
    Absorbed,
    Plain,
}
Expand description

Role of a C argument in the generated Rust wrapper method.

Each argument is classified once: is it &self? A &OtherWrapper param? A callback that must be retained? etc. The classification drives all emission (signature, FFI call, handler registration, and the _fn variant).

Variants§

§

SelfPointer

*mut <own type> — becomes &self / self.get_inner().

§

WrapperPointer

*mut <other wrapper>&OtherWrapper param, name.get_inner() call.

§

HandlerSync

Callback invoked only during the FFI call — Option<&Handler<T>>, _fn capable.

§

HandlerRetainedBorrowed

Callback the C client retains — borrow style (Option<&Handler<T>>), registered as a dependency of self.

§

HandlerRetainedOwned

Callback the C client retains — owned setter style (Option<T>), heap-allocated in a prelude, registered, and returned to the caller.

§

Absorbed

clientd / length / merged arguments that emit nothing of their own.

§

Plain

Everything else — handled by the existing ReturnType conversions.

Trait Implementations§

Source§

impl Clone for ArgRole

Source§

fn clone(&self) -> ArgRole

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ArgRole

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for ArgRole

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for ArgRole

Source§

impl Eq for ArgRole

Source§

impl StructuralPartialEq for ArgRole

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.