Struct pyo3_macros_backend::method::FnSpec

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>,
    pub deprecations: Deprecations<'a>,
}

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>

deprecations: Deprecations<'a>

Implementations

impl<'a> FnSpec<'a>

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

Parser function signature and function attributes

pub fn null_terminated_python_name(&self) -> LitStr

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

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

Return a C wrapper function for this signature.

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.

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

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

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__.