Struct kerbalobjects::ko::sections::StringTable

pub struct StringTable { /* private fields */ }

A string table section in a KerbalObject file.

A module describing a string table section in a Kerbal Object file. This section stores a list of strings, which other Kerbal Object constructs can index into.

Each section contains as its first index (index 0) an empty string.

Implementations

impl StringTable

pub fn new(section_index: SectionIdx) -> Self

Creates a new string table section with the provided section index

pub fn with_capacity(amount: usize, section_index: SectionIdx) -> Self

Creates a new string table section with the provided section index, with internal data structures pre-allocated for the provided number of strings, +1 for the null string at index 0.

pub fn get(&self, index: StringIdx) -> Option<&String>

Gets the string at the index into this string table, or None if it doesn’t exist

pub fn position(&self, s: impl AsRef<str>) -> Option<StringIdx>

Locates a given string in this string table and returns the index if it does exist, or None if it doesn’t

pub fn strings(&self) -> Iter<'_, String>

Returns an iterator over all of the strings contained in this string table

pub fn add_checked(&mut self, new_str: impl Into<String>) -> StringIdx

Adds a string to this string table, but checks if it is already in this table. Returns the index of the string, if it already existed, the index is just found and returned. If it doesn’t, it is inserted and the new index is returned.

pub fn add(&mut self, new_str: impl Into<String>) -> StringIdx

Unconditionally adds a string to this string table and returns the index of it

pub fn size(&self) -> u32

The size of this string table section in bytes

pub fn section_index(&self) -> SectionIdx

The index of this section’s section header

pub fn parse( source: &mut BufferIterator<'_>, size: u32, section_index: SectionIdx ) -> Result<Self, StringTableParseError>

Parses a StringTable using the provided buffer, its expected size, and the section’s section index

pub fn write(&self, buf: &mut impl WritableBuffer)

Writes the binary representation of this string table to the provided buffer

Trait Implementations

impl Debug for StringTable

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

Formats the value using the given formatter.