pyo3_macros_backend::method

Struct FnSpec

Source
pub struct FnSpec<'a> {
    pub tp: FnType,
    pub name: &'a Ident,
    pub python_name: Ident,
    pub signature: FunctionSignature<'a>,
    pub convention: CallingConvention,
    pub text_signature: Option<KeywordAttribute<text_signature, TextSignatureAttributeValue>>,
    pub asyncness: Option<Async>,
    pub unsafety: Option<Unsafe>,
}

Fields§

§tp: FnType§name: &'a Ident§python_name: Ident§signature: FunctionSignature<'a>§convention: CallingConvention§text_signature: Option<KeywordAttribute<text_signature, TextSignatureAttributeValue>>§asyncness: Option<Async>§unsafety: Option<Unsafe>

Implementations§

Source§

impl<'a> FnSpec<'a>

Source

pub fn parse( sig: &'a mut Signature, meth_attrs: &mut Vec<Attribute>, options: PyFunctionOptions, ) -> Result<FnSpec<'a>>

Parser function signature and function attributes

Source

pub fn null_terminated_python_name(&self, ctx: &Ctx) -> LitCStr

Source

fn parse_fn_type( sig: &Signature, meth_attrs: &mut Vec<Attribute>, python_name: &mut Option<Ident>, ) -> Result<FnType>

Source

pub fn get_wrapper_function( &self, ident: &Ident, cls: Option<&Type>, ctx: &Ctx, ) -> Result<TokenStream>

Return a C wrapper function for this signature.

Source

pub fn get_methoddef( &self, wrapper: impl ToTokens, doc: &PythonDoc, ctx: &Ctx, ) -> TokenStream

Return a PyMethodDef constructor for this function, matching the selected calling convention.

Source

pub fn get_doc(&self, attrs: &[Attribute], ctx: &Ctx) -> PythonDoc

Forwards to utils::get_doc with the text signature of this spec.

Source

pub fn text_signature_call_signature(&self) -> Option<String>

Creates the parenthesised arguments list for __text_signature__ snippet based on this spec’s signature and/or attributes. Prepend the callable name to make a complete __text_signature__.

Auto Trait Implementations§

§

impl<'a> Freeze for FnSpec<'a>

§

impl<'a> RefUnwindSafe for FnSpec<'a>

§

impl<'a> !Send for FnSpec<'a>

§

impl<'a> !Sync for FnSpec<'a>

§

impl<'a> Unpin for FnSpec<'a>

§

impl<'a> UnwindSafe for FnSpec<'a>

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, 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> SizedTypeProperties for T

Source§

#[doc(hidden)] const IS_ZST: bool = _

🔬This is a nightly-only experimental API. (sized_type_properties)
true if this type requires no storage. false if its size is greater than zero. Read more
Source§

#[doc(hidden)] const LAYOUT: Layout = _

🔬This is a nightly-only experimental API. (sized_type_properties)
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.
⚠️ Internal Docs ⚠️ Not Public API 👉 Official Docs Here