Struct LuaSignature

pub struct LuaSignature {
    pub generic_params: Vec<(String, Option<LuaType>)>,
    pub overloads: Vec<Arc<LuaFunctionType>>,
    pub param_docs: HashMap<usize, LuaDocParamInfo>,
    pub params: Vec<String>,
    pub return_docs: Vec<LuaDocReturnInfo>,
    pub resolve_return: SignatureReturnStatus,
    pub is_colon_define: bool,
    pub is_async: bool,
    pub is_nodiscard: bool,
}

Fields

generic_params: Vec<(String, Option<LuaType>)>

overloads: Vec<Arc<LuaFunctionType>>

param_docs: HashMap<usize, LuaDocParamInfo>

params: Vec<String>

return_docs: Vec<LuaDocReturnInfo>

resolve_return: SignatureReturnStatus

is_colon_define: bool

is_async: bool

is_nodiscard: bool

Implementations

impl LuaSignature

pub fn new() -> Self

pub fn is_generic(&self) -> bool

pub fn is_resolve_return(&self) -> bool

pub fn get_type_params(&self) -> Vec<(String, Option<LuaType>)>

pub fn find_param_idx(&self, param_name: &str) -> Option<usize>

pub fn get_param_info_by_name( &self, param_name: &str, ) -> Option<&LuaDocParamInfo>

pub fn get_param_info_by_id(&self, idx: usize) -> Option<&LuaDocParamInfo>

pub fn get_return_types(&self) -> Vec<LuaType>

pub fn is_method(&self) -> bool

pub fn to_doc_func_type(&self) -> Arc<LuaFunctionType>

pub fn to_call_operator_func_type(&self) -> Arc<LuaFunctionType>

Trait Implementations

impl Debug for LuaSignature

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

Formats the value using the given formatter.