Struct Section

pub struct Section<'tape, 'data> {
    tape: &'tape mut Tape<'data>,
    name: String,
}

A section of the save file. It directly maps to a SaveFileObject and is the largest unit of data in the save file. Since Tape holds state, it must be mutable for the section to be parsable.

Fields

tape: &'tape mut Tape<'data>

name: String

Implementations

impl<'tape, 'data> Section<'tape, 'data>

pub fn new(tape: &'tape mut Tape<'data>, name: String) -> Self

Create a new section from a tape. The section will be named name and will start at offset and end at end. The first token of the section (pointed at by offset) is expected to an object or array token. The end token is not included in the section.

pub fn get_name(&self) -> &str

Get the name of the section.

pub fn skip(&mut self) -> Result<(), SectionError>

Skip the section. This must be called if the section is not going to be parsed.

pub fn parse(&mut self) -> Result<SaveFileObject, SectionError>

Parse the section into a SaveFileObject. This will consume the section.

Trait Implementations

impl Debug for Section<'_, '_>

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

Formats the value using the given formatter.