Struct ProjectFile 

pub struct ProjectFile<'a> { /* private fields */ }

Available on crate feature generic only.

プロジェクトファイルにデータを保存・取得するための構造体。

Implementations

impl<'a> ProjectFile<'a>

pub unsafe fn from_raw(raw: *mut PROJECT_FILE) -> Self

生ポインタからProjectFileを作成します。

Safety

• rawは有効なPROJECT_FILEポインタである必要があります。

pub fn get_param_string(&self, key: &str) -> Result<String, ProjectFileError>

プロジェクトに保存されている文字列を取得します。

Errors

• keyにヌル文字が含まれている場合、失敗します。
• 文字列が見つからなかった場合は失敗します。

pub fn get_param_binary( &self, key: &str, data: &mut [u8], ) -> Result<(), ProjectFileError>

プロジェクトに保存されているバイナリデータを取得します。

Errors

• keyにヌル文字が含まれている場合、失敗します。
• data の長さが保存されているデータの長さと一致しない場合、失敗します。
• 指定されたキーに対応するデータが存在しない場合、失敗します。

pub fn set_param_string( &mut self, key: &str, value: &str, ) -> Result<(), ProjectFileError>

プロジェクトに文字列を保存します。

Errors

key、valueにヌル文字が含まれている場合、失敗します。

pub fn set_param_binary( &mut self, key: &str, data: &[u8], ) -> Result<(), ProjectFileError>

プロジェクトにバイナリデータを保存します。

Errors

• data の長さが4096バイトを超える場合、失敗します。
• keyにヌル文字が含まれている場合、失敗します。

pub fn clear_params(&mut self)

プロジェクトに保存されているデータをすべて削除します。

pub fn get_path(&self) -> Option<PathBuf>

プロジェクトファイルのパスを取得します。

impl<'a> ProjectFile<'a>

pub fn serialize<T: Serialize>(&mut self, key: &str, value: &T) -> AnyResult<()>

Available on crate feature serde only.

プロジェクトにデータをシリアライズして保存します。

Note

今現在の実装ではデータはMessagePackにシリアライズされた後にZstdで圧縮されています。

Errors

• シリアライズに失敗した場合。
• 圧縮に失敗した場合。

pub fn deserialize<T: DeserializeOwned>(&self, key: &str) -> AnyResult<T>

Available on crate feature serde only.

プロジェクトからデータをデシリアライズして取得します。