Struct Parameter

pub struct Parameter {
    pub arg: String,
    pub annotation: Option<Box<ExprType>>,
    pub type_comment: Option<String>,
    pub lineno: Option<usize>,
    pub col_offset: Option<usize>,
    pub end_lineno: Option<usize>,
    pub end_col_offset: Option<usize>,
}

A function parameter definition with optional type annotation and default value.

Fields

arg: String

Parameter name

annotation: Option<Box<ExprType>>

Optional type annotation

type_comment: Option<String>

Optional type comment (deprecated Python feature)

lineno: Option<usize>

Position information

col_offset: Option<usize>

end_lineno: Option<usize>

end_col_offset: Option<usize>

Trait Implementations

impl Clone for Parameter

fn clone(&self) -> Parameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CodeGen for Parameter

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 to_rust( self, ctx: Self::Context, options: Self::Options, symbols: Self::SymbolTable, ) -> 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 find_symbols(self, symbols_in: 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 get_docstring(&self) -> Option<String>

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

impl Debug for Parameter

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

Formats the value using the given formatter.

impl Default for Parameter

fn default() -> Parameter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Parameter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> FromPyObject<'a> for Parameter

fn extract_bound(ob: &Bound<'a, PyAny>) -> PyResult<Self>

Extracts Self from the bound smart pointer obj.

impl Node for Parameter

fn lineno(&self) -> Option<usize>

A method for getting the starting line number of the node. This may not exist for all node types.

fn col_offset(&self) -> Option<usize>

A method for getting the starting column of the node. This may not exist for all node types.

fn end_lineno(&self) -> Option<usize>

A method for getting the ending line number of the node. This may not exist for all node types.

fn end_col_offset(&self) -> Option<usize>

A method for getting the ending column of the node. This may not exist for all node types.

fn error_message( &self, mod_name: impl AsRef<str>, message: impl AsRef<str>, ) -> String

Generate an error message for the current code, adding line and column number.

impl PartialEq for Parameter

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Parameter

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 Parameter