Available on crate feature
module only.Expand description
§aviutl2-rs / module
AviUtl2のスクリプトモジュールを実装するためのモジュール。 大まかな流れ：
ScriptModuleトレイトを実装し、かつ#[aviutl2::plugin(ScriptModule)]属性を付与した構造体を定義するcrate::module::functionsで関数を定義するcrate::register_script_module!マクロを使用してプラグインを登録する
サンプルはhttps://github.com/sevenc-nanashi/aviutl2-rs/tree/main/examples/username-moduleを参照してください。
Re-exports§
pub use super::common::*;
Macros§
- script_
module_ callback push_result_functionで返せるスクリプトモジュール関数コールバックを作成します。- script_
module_ direct_ callback push_result_functionで返せるdirect形式のスクリプトモジュール関数コールバックを作成します。
Structs§
- Erased
Script Module User Data - ScriptModuleUserDataから型パラメータを消去した構造体。
- Module
Function - スクリプトモジュールプラグインの関数を表す構造体。
- Param
Conversion Error - 引数変換に失敗した場合のエラー。
- Script
Module Call Handle - 関数の引数・返り値を扱うための型とトレイト。
- Script
Module Function Callback push_result_functionで返すスクリプトモジュール関数コールバック。- Script
Module Param Array - スクリプトモジュールの引数として渡される配列。
- Script
Module Param Table - スクリプトモジュールの引数として渡される連想配列。
- Script
Module Table - スクリプトモジュールプラグインの情報を表す構造体。
- Script
Module User Data - ユーザーデータとして相互変換する構造体。
Enums§
- GetParam
Error - 引数の取得に失敗した場合のエラー。
- Into
Script Module Return Value Error IntoScriptModuleReturnValue::push_intoで使われるエラー。- Param
Type - スクリプトモジュールで渡された引数の型。
- Script
Module Call Handle Error ScriptModuleCallHandle関連のエラー。- Script
Module Return Value - スクリプトモジュールの関数の戻り値の型を表す列挙型。
Traits§
- AsScript
Module User Data - ユーザーデータとして変換できる型のトレイト。
- From
Script Module Integer - スクリプトモジュールの整数値から変換できる型。
- From
Script Module Param - スクリプトモジュールの引数として受け取れる値。
- From
Script Module Param Table - 連想配列の値として使える型。
- Into
Script Module Return Value - 関数の戻り値として使える型。
- Script
Module - スクリプトモジュールプラグインのトレイト。
このトレイトを実装し、
crate::register_script_module!マクロを使用してプラグインを登録します。 - Script
Module Functions - スクリプトモジュールの関数一覧を返すトレイト。
functionsマクロで実装できます。
Type Aliases§
Attribute Macros§
Derive Macros§
- From
Script Module Param FromScriptModuleParamを自動で実装するためのマクロ。- Into
Script Module Return Value IntoScriptModuleReturnValueを自動で実装するためのマクロ。