Enum kerbalobjects::KOSValue

pub enum KOSValue {
    Null,
    Bool(bool),
    Byte(i8),
    Int16(i16),
    Int32(i32),
    Float(f32),
    Double(f64),
    String(String),
    ArgMarker,
    ScalarInt(i32),
    ScalarDouble(f64),
    BoolValue(bool),
    StringValue(String),
}

An internal value within Kerbal Operating System.

These are documented within the GitHub repo’s KSM Docs. These are used as operands to instructions and stored in the KO file’s data section, and a KSM file’s argument section.

Each value takes up 1 byte just for the “data type” so that kOS knows how to load the value.

The “Value” types (ScalarInt, ScalarDouble, BoolValue, StringValue) are different from their non-value counterparts in that the “Value” types have more built-in suffixes, and are the type used when there are any user-created values, as opposed to instruction operands. See KSM docs for more information.

Variants

Null

A null value, rarely used. Only takes up 1 byte.

Bool(bool)

A boolean. Takes up 2 bytes.

Byte(i8)

A signed byte. Takes up 2 bytes.

Int16(i16)

A signed 16-bit integer. Takes up 3 bytes.

Int32(i32)

A signed 32-bit integer. Takes up 5 bytes.

Float(f32)

A 32-bit floating point number. Takes up 5 bytes.

Double(f64)

A 64-bit floating point number. Takes up 9 bytes.

String(String)

A string. Takes up 2 + length bytes.

ArgMarker

An argument marker. Takes up 1 byte.

ScalarInt(i32)

A signed 32-bit integer. Takes up 5 bytes.

ScalarDouble(f64)

A 64-bit floating point number. Takes up 9 bytes.

BoolValue(bool)

A boolean. Takes up 2 bytes.

StringValue(String)

A string. Takes up 2 + length bytes.

Implementations

impl KOSValue

pub fn size_bytes(&self) -> usize

Returns the size of the value in bytes.

Trait Implementations

impl Clone for KOSValue

fn clone(&self) -> KOSValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KOSValue

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

Formats the value using the given formatter.

impl FromBytes for KOSValue

type Error = KOSValueParseError

The error type returned when the conversion fails

fn from_bytes(source: &mut BufferIterator<'_>) -> Result<Self, Self::Error>where Self: Sized,

Parses a value from the buffer iterator.

impl Hash for KOSValue

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<KOSValue> for KOSValue

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl ToBytes for KOSValue

fn to_bytes(&self, buf: &mut impl WritableBuffer)

Converts a type into bytes and appends it to the buffer.

impl Eq for KOSValue