Struct EffFile

pub struct EffFile {
    pub effect_handles: Vec<EffectHandle>,
    pub effect_group_elements: Vec<EffectGroupElement>,
    pub effect_model_entries: Vec<EffectModelEntry>,
    pub effect_handle_names: Vec<CString>,
    pub effect_model_names: Vec<CString>,
    pub parent_joint_names: Vec<CString>,
    pub resource_data: Option<Vec<u8>>,
}

The container type for the EFF file format.

Fields

effect_handles: Vec<EffectHandle>

Collection of effect handles.

effect_group_elements: Vec<EffectGroupElement>

Collection of effect group elements.

effect_model_entries: Vec<EffectModelEntry>

Collection of effect model entries.

effect_handle_names: Vec<CString>

Collection of effect handle names.

effect_model_names: Vec<CString>

Collection of effect model names.

parent_joint_names: Vec<CString>

Collection of parent joint names to emitter sets in effect group elements.

resource_data: Option<Vec<u8>>

Data buffer for the contained file resource.

Implementations

impl EffFile

pub fn from_file<P: AsRef<Path>>(path: P) -> BinResult<Self>

Reads the data from the given file path.

pub fn read<R: Read + Seek>(reader: &mut R) -> BinResult<Self>

Reads the data from the given reader.

pub fn write<W: Write + Seek>(&self, writer: &mut W) -> BinResult<()>

Writes the data to the given writer.

pub fn write_to_file<P: AsRef<Path>>(&self, path: P) -> BinResult<()>

Writes the data to the given file path.

pub fn write_resource_to_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

Writes the data from the resource data buffer to the given file path.

Trait Implementations

impl BinRead for EffFile

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of read_args() and read_options().

fn read_options<R: Read + Seek>( __binrw_generated_var_reader: &mut R, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<Self>

Read Self from the reader using the given Endian and arguments.

fn read_be<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming big-endian byte order.

fn read_le<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming little-endian byte order.

fn read_ne<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read T from the reader assuming native-endian byte order.

fn read_be_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming big-endian byte order, using the given arguments.

fn read_le_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming little-endian byte order, using the given arguments.

fn read_ne_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read T from the reader, assuming native-endian byte order, using the given arguments.

impl BinWrite for EffFile

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of write_args() and write_options().

fn write_options<W: Write + Seek>( &self, __binrw_generated_var_writer: &mut W, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<()>

Write Self to the writer using the given Endian and arguments.

fn write_be<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming big-endian byte order.

fn write_le<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming little-endian byte order.

fn write_be_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming big-endian byte order, using the given arguments.

fn write_le_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming little-endian byte order, using the given arguments.

impl Debug for EffFile

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

Formats the value using the given formatter.

impl ReadMagic for EffFile

const MAGIC: Self::MagicType

The magic number.

type MagicType = [u8; 4]

The type of the magic number.

impl WriteMagic for EffFile

const MAGIC: Self::MagicType

The magic number.

type MagicType = [u8; 4]

The type of the magic number.