Struct SerializationInterface

pub struct SerializationInterface(/* private fields */);

Interface for interacting with SKSE’s serialization functions.

This struct provides methods for interacting with serialization operations such as setting unique IDs, handling callbacks for form deletions and loads, and reading/writing record data.

Implementations

impl SerializationInterface

pub const VERSION: u32 = 4u32

The version number of the serialization interface.

pub const fn version(&self) -> u32

Returns the version of the serialization interface.

pub fn set_unique_id(&self, uid: u32) -> Result<(), ApiStorageError>

Sets a unique identifier for the serialization interface.

Errors

Returns an error if the internal global API storage is uninitialized (e.g., if skse::init has not been called).

pub fn set_form_delete_callback( &self, callback: fn(handle: VMHandle), ) -> Result<(), ApiStorageError>

Sets a callback function that will be called when a form is deleted.

Errors

Returns an error if the internal global API storage is uninitialized (e.g., if skse::init has not been called).

pub fn set_load_callback( &self, callback: fn(&Self), ) -> Result<(), ApiStorageError>

Sets a callback function that will be called when the plugin is loaded.

Errors

Returns an error if the internal global API storage is uninitialized (e.g., if skse::init has not been called).

pub fn set_revert_callback( &self, callback: fn(&Self), ) -> Result<(), ApiStorageError>

Sets a callback function that will be called when the plugin is reverted.

Errors

Returns an error if the internal global API storage is uninitialized (e.g., if skse::init has not been called).

pub fn set_save_callback( &self, callback: fn(&Self), ) -> Result<(), ApiStorageError>

Sets a callback function that will be called when the plugin is saved.

Errors

Returns an error if the internal global API storage is uninitialized (e.g., if skse::init has not been called).

pub fn write_record<T>( &self, record_type: u32, version: u32, buf: &T, ) -> Result<(), Error>

Writes a record to the serialization interface.

Errors

Returns an error if the write operation fails or if the buffer length exceeds u32::MAX.

pub fn open_recode(&self, record_type: u32, version: u32) -> Result<(), Error>

Opens a record for writing.

Errors

Returns an error if the open operation fails.

pub fn write_record_data<T>(&self, buf: &[T]) -> Result<(), Error>

Writes record data to the serialization interface.

Errors

Returns an error if the write operation fails or if the buffer length exceeds u32::MAX.

pub fn read_record_data<T>(&self, buf: &mut [T]) -> u32

Reads record data into the provided buffer.

Returns

The number of bytes read.

pub fn get_next_record_info( &self, record_type: &mut u32, version: &mut u32, length: &mut u32, ) -> Result<(), Error>

Retrieves the next record’s type, version, and length.

Errors

Returns an error if the operation fails.

pub fn resolve_form_id( &self, old: FormID, new: &mut FormID, ) -> Result<(), Error>

Resolves the new form ID based on an old form ID.

Errors

Returns an error if the form ID resolution fails.

pub fn resolve_handle( &self, old: VMHandle, new: &mut VMHandle, ) -> Result<(), Error>

Resolves the new handle based on an old handle.

Errors

Returns an error if the handle resolution fails.

Trait Implementations

impl Clone for SerializationInterface

fn clone(&self) -> SerializationInterface

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SerializationInterface

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

Formats the value using the given formatter.