Struct PyMethodDef 

pub struct PyMethodDef {
    pub name: &'static str,
    pub func: &'static dyn PyNativeFn,
    pub flags: PyMethodFlags,
    pub doc_off: u32,
    pub doc_len: u32,
    pub doc_body_pending: bool,
    pub doc: Option<&'static str>,
}

Fields

name: &'static str

func: &'static dyn PyNativeFn

flags: PyMethodFlags

doc_off: u32

Start of the database body. Read only when doc_len != 0. Absent when the doc feature is off, as are doc_len and doc_body_pending.

doc_len: u32

Length of the database body. 0 means the body is not a database span: doc is the whole text, or there is no body.

doc_body_pending: bool

The body is still taken from the owning class’s attribute table. True only when the method has no Rust doc body and expansion did not resolve a database span. concat_with_attr_docs copies that span into doc_off/doc_len when the table has one, then sets this to false. False means the body is already settled: a Rust doc, a span resolved while expanding the method, or no body at all.

doc: Option<&'static str>

Static text beside the database span. None when there is no static text: the body is the doc_len span, or there is no docstring. Some is a plain docstring, a full internal docstring, or only the signature prefix while the body is the doc_len span or still pending.

Implementations

impl PyMethodDef

pub fn item_doc(&self) -> ItemDoc

pub const fn new_const<Kind>( name: &'static str, func: impl IntoPyNativeFn<Kind>, flags: PyMethodFlags, doc: ItemDoc, ) -> Self

pub const fn new_raw_const( name: &'static str, func: impl PyNativeFn, flags: PyMethodFlags, doc: ItemDoc, ) -> Self

pub fn to_proper_method( &'static self, class: &'static Py<PyType>, ctx: &Context, ) -> PyObjectRef

pub const fn to_function(&'static self) -> PyNativeFunction

pub fn to_method( &'static self, class: &'static Py<PyType>, ctx: &Context, ) -> PyMethodDescriptor

pub const fn to_bound_method( &'static self, obj: PyObjectRef, class: &'static Py<PyType>, ) -> PyNativeMethod

pub fn build_function(&'static self, ctx: &Context) -> PyRef<PyNativeFunction>

pub fn build_bound_function( &'static self, ctx: &Context, obj: PyObjectRef, ) -> PyRef<PyNativeFunction>

pub fn build_method( &'static self, ctx: &Context, class: &'static Py<PyType>, ) -> PyRef<PyMethodDescriptor>

pub fn build_bound_method( &'static self, ctx: &Context, obj: PyObjectRef, class: &'static Py<PyType>, ) -> PyRef<PyNativeMethod>

pub fn build_classmethod( &'static self, ctx: &Context, class: &'static Py<PyType>, ) -> PyRef<PyClassMethodDescriptor>

pub fn build_staticmethod( &'static self, ctx: &Context, class: &'static Py<PyType>, ) -> PyRef<PyNativeMethod>

pub const fn concat_with_attr_docs<const N: usize>( method_groups: &[&[Self]], docs: &[(&str, u32, u32)], ) -> [Self; N]

Concatenate method groups. A pending body is copied from docs, then cleared.

Trait Implementations

impl Clone for PyMethodDef

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PyMethodDef

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

Formats the value using the given formatter.