Struct SectionData

pub struct SectionData<'a> {
    pub content: &'a str,
    pub content_size: u16,
    pub tag: &'a str,
}

A Section is variable-length data structure common to several binary DAT files. A Resource (ie, a Macro or Gearset) is then made out of a repeating pattern of sections. SectionData is used to build sections with references to pre-allocated buffers. To build a section that owns its own data, use Section.

Section-using file types

ACQ, KEYBIND, MACRO, and MACROSYS. See SECTION_BASED_TYPES.

Data Structure

0
0  1  2  3  ...
|  |--|  |- ...
|  |     \_ null-terminated utf8 string
|  \_ u16le content_size
\_ utf8 char section_type

Fields

content: &'a str

Data content of the section.

content_size: u16

Length of section content in bytes. Includes terminating null.

tag: &'a str

Single char string data type tag. The meaning of this tag varies by file type. Some tags are reused with different meanings between types.

Implementations

impl<'a> SectionData<'a>

pub fn new(tag: &'a str, content: &'a str) -> Result<Self, DATError>

Builds a new SectionData with a given tag and content

Examples

use libxivdat::section::SectionData;

let new_section = SectionData::new("T", "Macro title!").unwrap();
assert_eq!(new_section.tag, "T");
assert_eq!(new_section.content, "Macro title!");
assert_eq!(new_section.content_size, 13);

Trait Implementations

impl<'a> Clone for SectionData<'a>

fn clone(&self) -> SectionData<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SectionData<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a Section> for SectionData<'a>

fn from(x: &'a Section) -> Self

Converts to this type from the input type.

impl From<&SectionData<'_>> for Section

fn from(x: &SectionData<'_>) -> Self

Converts to this type from the input type.

impl From<SectionData<'_>> for Vec<u8>

fn from(x: SectionData<'_>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for SectionData<'a>

fn eq(&self, other: &SectionData<'a>) -> 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<'a> TryFrom<&'a [u8]> for SectionData<'a>

type Error = DATError

The type returned in the event of a conversion error.

fn try_from(x: &'a [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> Copy for SectionData<'a>

impl<'a> Eq for SectionData<'a>

impl<'a> StructuralPartialEq for SectionData<'a>