Enum ssbh_lib::formats::matl::Matl

pub enum Matl {
    V15 {
        entries: SsbhArray<MatlEntryV15>,
    },
    V16 {
        entries: SsbhArray<MatlEntryV16>,
    },
}

A container of materials. Compatible with file version 1.5 and 1.6.

Variants

V15

Fields

entries: SsbhArray<MatlEntryV15>

V16

Fields

entries: SsbhArray<MatlEntryV16>

Implementations

impl Matl

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self, ReadSsbhError>

Tries to read the current SSBH type from path. The entire file is buffered for performance.

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

Tries to read the current SSBH type from reader. For best performance when opening from a file, use from_file instead.

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

Tries to write the SSBH type to writer. For best performance when writing to a file, use write_to_file instead.

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

Tries to write the current SSBH type to path. The entire file is buffered for performance.

Trait Implementations

impl BinRead for Matl

type Args<'__binrw_generated_args_lifetime> = (u16, u16)

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 Clone for Matl

fn clone(&self) -> Matl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Matl

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

Formats the value using the given formatter.

impl PartialEq for Matl

fn eq(&self, other: &Matl) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SsbhWrite for Matl

fn ssbh_write<W: Write + Seek>( &self, writer: &mut W, data_ptr: &mut u64 ) -> Result<()>

Writes the byte representation of self to writer. data_ptr is assumed to be the absolute offset where the next data stored behind an offset will be written. Struct that contains no offsets as fields can skip updating data_ptr.

fn size_in_bytes(&self) -> u64

The offset in bytes between successive elements in an array of this type. This should include any alignment or padding.

fn alignment_in_bytes() -> u64

The alignment for pointers of this type, which is useful for offset calculations.

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

where W: Write + Seek,

Writes the byte representation of self to writer. This is a convenience method for ssbh_write that handles initializing the data pointer.

impl Version for Matl

fn major_minor_version(&self) -> (u16, u16)

impl StructuralPartialEq for Matl