Struct kerbalobjects::ksm::sections::ArgumentSection

pub struct ArgumentSection { /* private fields */ }

An argument section within a KSM file.

You can create a new ArgumentSection using new() and then add items using add():

This section stores all operands of every instruction contained within the code sections of a KSM file, which all index into the file’s argument section.

use kerbalobjects::KOSValue;
use kerbalobjects::ksm::sections::ArgumentSection;

let mut arg_section = ArgumentSection::new();

let index = arg_section.add(KOSValue::Int16(2));

See the file format docs for more details.

Implementations

impl ArgumentSection

pub fn new() -> Self

Creates a new empty ArgumentSection

pub fn with_capacity(amount: usize) -> Self

Creates a new empty ArgumentSection, with the provided pre-allocated size

pub fn with_arguments_checked( self, iter: impl IntoIterator<Item = KOSValue> ) -> (Self, Vec<ArgIndex>)

A builder-style method that takes an iterator of KOSValues that should be added to this ArgumentSection

This variant performs checking as the items are added

This also returns a Vec that represent all of the indices that every element inserted resides at, and will contain duplicates if duplicate elements were added.

pub fn with_arguments_unchecked( self, iter: impl IntoIterator<Item = KOSValue> ) -> (Self, Vec<ArgIndex>)

A builder-style method that takes an iterator of KOSValues that should be added to this ArgumentSection

This variant does not perform checking as the items are added

This also returns a Vec that represent all of the indices that every element inserted resides at, and will not contain duplicates even if duplicate elements were added.

pub fn num_index_bytes(&self) -> IntSize

Returns the NumArgIndexBytes that this argument section currently requires.

This represents the current size range of this argument section, because this is the number of bytes that are required to reference an item within the argument section.

pub fn find(&self, value: &KOSValue) -> Option<ArgIndex>

Returns the ArgIndex into this argument section that a KOSValue resides at, or None if no such value is in this section.

pub fn add_checked(&mut self, value: KOSValue) -> ArgIndex

Add a new KOSValue to this argument section, checking if it is a duplicate, and returning the ArgIndex of the value. If it already exists, the ArgIndex of that value is returned, if it does not, then it is added, and the new ArgIndex is returned.

pub fn add(&mut self, argument: KOSValue) -> ArgIndex

Adds a new KOSValue to this argument section.

This does not do any sort of checking for duplication and will simply add it.

This function returns the ArgIndex that can be used to refer to the inserted value, for example when trying to reference it in an instruction.

pub fn get(&self, index: ArgIndex) -> Option<&KOSValue>

Gets a reference to a particular KOSValue in this argument section.

This is done using the ArgIndex that is returned when the value was added.

Returns None of the ArgIndex doesn’t refer to a valid value.

pub fn arguments(&self) -> Iter<'_, KOSValue>

Returns an iterator over all of the KOSValues that are stored in this section.

pub fn size_bytes(&self) -> usize

Returns the size in bytes that this section would take up in total in the final binary file.

pub fn parse( source: &mut BufferIterator<'_> ) -> Result<Self, ArgumentSectionParseError>

Attempts to parse an argument section from the current buffer iterator.

This can fail if the buffer runs out of bytes, or if the argument section is malformed.

pub fn write(&self, buf: &mut Vec<u8>)

Appends the byte representation of this argument section to a buffer of bytes

Trait Implementations

impl Clone for ArgumentSection

fn clone(&self) -> ArgumentSection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArgumentSection

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

Formats the value using the given formatter.

impl Default for ArgumentSection

fn default() -> Self

Returns the “default value” for a type.