Struct FunctionDef 

pub struct FunctionDef {
    pub name: String,
    pub args: ParameterList,
    pub body: Vec<Statement>,
    pub decorator_list: Vec<ExprType>,
    pub returns: Option<Box<ExprType>>,
}

Fields

name: String

args: ParameterList

body: Vec<Statement>

decorator_list: Vec<ExprType>

returns: Option<Box<ExprType>>

The function’s return annotation (-> int), if present.

Implementations

impl FunctionDef

pub fn resolved_return_type(&self) -> Option<TokenStream>

The return type the generated Rust function actually carries, if any.

Inference from the body comes first (it reflects the type the body actually produces — e.g. a string literal is a &’static str even under a -> str annotation); an explicit annotation with a known Rust mapping is the fallback for bodies inference can’t see through. Both require the body to return on every path: a fall-through path yields (), which no concrete annotation can type. -> None and unmappable annotations yield None.

Tools generating call-through code (e.g. PyO3 wrappers) must use this same method so their signatures match the generated function.

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

The Python-source text of a return annotation the generated function does not honor: the body can fall through (implicitly returning None), so the generated function returns () no matter what the annotation claims. This frequently marks a bug in the Python source — the author declared a return type but not every path returns one — so it must be surfaced, not silently reproduced.

pub fn lossy_conversion_notes(&self) -> Vec<String>

Human-readable notes for every lossy conversion this function’s signature underwent. These become the #[deprecated] note on the generated function, and conversion tools report them to the user.

pub fn dropped_default_parameters(&self) -> Vec<String>

Names of parameters whose Python default values cannot be carried into the generated Rust signature (Rust has no default arguments). Used to attach a call-site warning to the generated function and to let tools report the loss during conversion.

pub fn inferred_return_type(&self) -> Option<TokenStream>

Infer a return type when the function is guaranteed to return on every control-flow path AND every return value in the body maps to the same simple type — either directly (a constant or f-string) or via a local variable assigned a constant. Partial/conditional returns (which implicitly return None on the fall-through path), mixed types, and uninferable values all yield None so the function stays unannotated, as before.

Trait Implementations

impl Clone for FunctionDef

fn clone(&self) -> FunctionDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CodeGen for FunctionDef

type Context = CodeGenContext

A type, generally an enum, that passes the code generator the context of the node.

type Options = PythonOptions

A struct representing the set of compilation options.

type SymbolTable = SymbolTableScopes

A trait for a symbol table

fn find_symbols(self, symbols: Self::SymbolTable) -> Self::SymbolTable

A default implementation for find_symbols(), which simply returns the input. Language nodes that modify the symbol table should override this method.

fn to_rust( self, ctx: Self::Context, options: Self::Options, symbols: SymbolTableScopes, ) -> Result<TokenStream, Box<dyn Error>>

A trait method to output Rust code in a general sense. The output should be stream of Rust tokens, however, it is not guaranteed that it will fully compile because of scoping errors and other checks that don’t occur until later.

fn get_docstring(&self) -> Option<String>

A trait method for extracting a docstring from an object that can have a docstring.

impl Debug for FunctionDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionDef

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, 'py> FromPyObject<'a, 'py> for FunctionDef

type Error = PyErr

The type returned in the event of a conversion error.

fn extract(ob: Borrowed<'a, 'py, PyAny>) -> PyResult<Self>

Extracts Self from the bound smart pointer obj.

impl Object for FunctionDef

fn id(&self) -> usize

Returns the unique identifier of the object, which is the memory address of the object.

fn type(&self) -> String

Returns the type name of the object.

fn is<T: Object>(&self, other: &Option<T>) -> bool

Returns the type name of the object.

fn __getattribute__(&self, _name: impl AsRef<str>) -> Option<impl Object>

getattribute is called to look up an attribute of the object.

fn __dir__(&self) -> Vec<impl AsRef<str>>

dir is called to list the attributes of the object.

impl PartialEq for FunctionDef

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

Equality operator ==.

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

Inequality operator !=.

impl PyStatementTrait for FunctionDef

impl Serialize for FunctionDef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FunctionDef