Struct ESF 

pub struct ESF { /* private fields */ }

Represents a complete ESF file decoded in memory.

An ESF file contains a tree of nodes starting from a single root node. The root node is always a record node that contains all other data in the file.

Fields

• signature: Identifies the format version (CAAB, CBAB, etc.)
• unknown_1: Purpose unknown, typically 0
• creation_date: Unix timestamp or similar date value
• root_node: The top-level record node containing all file data

Implementations

impl ESF

pub fn signature(&self) -> &ESFSignature

Format signature identifying the ESF version (CAAB, CBAB, etc.).

pub fn unknown_1(&self) -> &u32

Unknown header field, typically 0. May be reserved for future use.

pub fn creation_date(&self) -> &u32

Creation timestamp of the ESF file.

pub fn root_node(&self) -> &NodeType

Root node of the node tree containing all ESF data. This is always a record node in valid ESF files.

impl ESF

pub fn set_signature(&mut self, val: ESFSignature) -> &mut Self

Format signature identifying the ESF version (CAAB, CBAB, etc.).

pub fn set_unknown_1(&mut self, val: u32) -> &mut Self

Unknown header field, typically 0. May be reserved for future use.

pub fn set_creation_date(&mut self, val: u32) -> &mut Self

Creation timestamp of the ESF file.

pub fn set_root_node(&mut self, val: NodeType) -> &mut Self

Root node of the node tree containing all ESF data. This is always a record node in valid ESF files.

impl ESF

pub fn clone_without_root_node(&self) -> Self

Creates a shallow copy of this ESF with the root node replaced by Invalid.

This is useful when you need to preserve the header metadata (signature, creation date, etc.) but want to rebuild or replace the node tree.

Trait Implementations

impl Clone for ESF

fn clone(&self) -> ESF

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ESF

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

Formats the value using the given formatter.

impl Decodeable for ESF

fn decode<R: ReadBytes>( data: &mut R, _extra_data: &Option<DecodeableExtraData<'_>>, ) -> Result<Self>

Decodes binary data into the implementing type.

impl Default for ESF

fn default() -> ESF

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ESF

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodeable for ESF

fn encode<W: WriteBytes>( &mut self, buffer: &mut W, extra_data: &Option<EncodeableExtraData<'_>>, ) -> Result<()>

Encodes the implementing type into binary data.

impl PartialEq for ESF

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ESF

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ESF