Struct ScriptModuleCallHandle 

pub struct ScriptModuleCallHandle { /* private fields */ }

Available on crate feature module only.

関数の引数・返り値を扱うための型とトレイト。

Implementations

impl ScriptModuleCallHandle

pub unsafe fn from_raw(ptr: *mut SCRIPT_MODULE_PARAM) -> ScriptModuleCallHandle

ポインタからScriptModuleParamを作成する。

Safety

ptrは有効なSCRIPT_MODULE_PARAMへのポインタである必要があります。

pub fn len(&self) -> usize

引数の数を返す。

pub fn is_empty(&self) -> bool

引数が与えられていないかを返す。

pub fn get_param_type(&self, index: usize) -> Option<ParamType>

渡された引数の型を取得する。

Note

引数が渡されていない場合はNoneを返します。

pub fn get_param<'a, T: FromScriptModuleParam<'a>>( &'a self, index: usize, ) -> GetParamResult<T, T::Error>

引数を取得する。

pub fn get_param_int(&self, index: usize) -> GetParamResult<i32>

引数を整数として取得する。

pub fn get_param_float(&self, index: usize) -> GetParamResult<f64>

引数を浮動小数点数として取得する。

pub fn get_param_str(&self, index: usize) -> GetParamResult<String>

引数を文字列として取得する。

pub fn get_param_data<T>(&self, index: usize) -> GetParamResult<*mut T>

引数をデータポインタとして取得する。

pub fn get_param_userdata<T: AsScriptModuleUserData>( &self, index: usize, ) -> GetParamResult<ScriptModuleUserData<T>, ParamConversionError>

引数をメタテーブルを持つ型付きuserdataとして取得する。

Note

Tではない型から作成されたuserdataを取得しようとした場合は GetParamError::ConversionErrorを返します。

pub fn get_param_boolean(&self, index: usize) -> GetParamResult<bool>

引数をブール値として取得する。

pub fn get_param_table_int( &self, index: usize, key: &str, ) -> ScriptModuleCallHandleResult<i32>

引数のテーブルの要素を整数として取得する。

Note

引数を取得できない場合は0を返します。

pub fn get_param_table_integer<T>( &self, index: usize, key: &str, ) -> ScriptModuleCallHandleResult<T, T::Error>

where T: FromScriptModuleInteger,

引数のテーブルの要素を整数として取得し、指定された型に変換する。

pub fn get_param_table_float( &self, index: usize, key: &str, ) -> ScriptModuleCallHandleResult<f64>

引数のテーブルの要素を浮動小数点数として取得する。

Note

引数を取得できない場合は0.0を返します。

pub fn get_param_table_str( &self, index: usize, key: &str, ) -> ScriptModuleCallHandleResult<Option<String>>

引数のテーブルの要素を文字列として取得する。

pub fn get_param_table_boolean( &self, index: usize, key: &str, ) -> ScriptModuleCallHandleResult<bool>

引数のテーブルの要素をブール値として取得する。

Note

引数を取得できない場合はfalseを返します。

pub fn get_param_array_len(&self, index: usize) -> usize

引数の配列の要素の数を取得する。

pub fn get_param_array_int(&self, index: usize, array_index: usize) -> i32

引数の配列の要素を数値として取得する。

pub fn get_param_array_float(&self, index: usize, array_index: usize) -> f64

引数の配列の要素を浮動小数点数として取得する。

pub fn get_param_array_str( &self, index: usize, array_index: usize, ) -> Option<String>

引数の配列の要素を文字列として取得する。

pub fn set_error(&mut self, message: &str) -> ScriptModuleCallHandleResult<()>

関数のエラーを設定する。

pub fn push_result<T: IntoScriptModuleReturnValue>( &mut self, value: T, ) -> Result<(), IntoScriptModuleReturnValueError<T::Err>>

関数の返り値を追加する。

pub fn push_result_int(&mut self, value: i32)

関数の返り値に整数を追加する。

pub fn push_result_float(&mut self, value: f64)

関数の返り値に浮動小数点数を追加する。

pub fn push_result_str( &mut self, value: &str, ) -> ScriptModuleCallHandleResult<()>

関数の返り値に文字列を追加する。

pub fn push_result_data<T>(&mut self, value: *const T)

関数の返り値にデータポインタを追加する。

pub fn push_result_function(&mut self, callback: ScriptModuleFunctionCallback)

関数の返り値に関数を追加する。

Note

メモリリークします。

pub fn push_result_meta_table<T: Into<ErasedScriptModuleUserData>>( &mut self, meta_table: T, )

関数の返り値にメタテーブルを追加する。

pub fn push_result_table_int<'a, T>( &mut self, table: T, ) -> ScriptModuleCallHandleResult<()>

where T: IntoIterator<Item = (&'a str, i32)>,

関数の返り値に整数の連想配列を追加する。

pub fn push_result_table_float<'a, T>( &mut self, table: T, ) -> ScriptModuleCallHandleResult<()>

where T: IntoIterator<Item = (&'a str, f64)>,

関数の返り値に浮動小数点数の連想配列を追加する。

pub fn push_result_table_str<'a, T>( &mut self, table: T, ) -> ScriptModuleCallHandleResult<()>

where T: IntoIterator<Item = (&'a str, &'a str)>,

関数の返り値に文字列の連想配列を追加する。

pub fn push_result_table_boolean<'a, T>( &mut self, table: T, ) -> ScriptModuleCallHandleResult<()>

where T: IntoIterator<Item = (&'a str, bool)>,

関数の返り値にブール値の連想配列を追加する。

pub fn push_result_array_int( &mut self, values: &[i32], ) -> ScriptModuleCallHandleResult<()>

関数の返り値に整数の配列を追加する。

pub fn push_result_array_float( &mut self, values: &[f64], ) -> ScriptModuleCallHandleResult<()>

関数の返り値に浮動小数点数の配列を追加する。

pub fn push_result_array_str( &mut self, values: &[&str], ) -> ScriptModuleCallHandleResult<()>

関数の返り値に文字列の配列を追加する。

pub fn push_result_array_boolean( &mut self, values: &[bool], ) -> ScriptModuleCallHandleResult<()>

関数の返り値にブール値の配列を追加する。

pub fn push_result_boolean(&mut self, value: bool)

関数の返り値にブール値を追加する。

pub fn read_section(&self) -> &ReadSection

読み取り専用の編集セクション。

Trait Implementations

impl Debug for ScriptModuleCallHandle

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

Formats the value using the given formatter.