Struct kerbalobjects::Symbol

pub struct Symbol { /* fields omitted */ }

Represents a single symbol in an object file. This can be a function, an object, program data, or anything else.

Implementations

impl Symbol

pub fn new(
    name: &str,
    value: KOSValue,
    size: u16,
    info: SymbolInfo,
    symbol_type: SymbolType,
    section_index: usize
) -> Symbol

Creates a new symbol from parts

pub fn read(
    symstrtab: &StringTable,
    symdata: &SymbolDataSection,
    reader: &mut KOFileReader
) -> Result<Symbol, Box<dyn Error>>

Reads a symbol from the symbol table of a KO file

pub fn write(&self, writer: &mut KOFileWriter) -> Result<(), Box<dyn Error>>

Write this symbol to a KOFileWriter

pub fn size(&self) -> u16

Returns the size of the data this symbol represents as stored in the KO file

pub fn width(&self) -> u32

Returns the width of one symbol in a symbol table

pub fn name(&self) -> &String

Returns the stored name of this symbol

pub fn value(&self) -> &KOSValue

Returns the kOS value that this symbol is associated with

pub fn get_type(&self) -> SymbolType

Returns this symbol's type

pub fn get_info(&self) -> SymbolInfo

Returns the visibility info of this symbol

pub fn set_name_index(&mut self, index: usize)

Sets the symbol's name's index into the Symbol String Table

pub fn set_value_index(&mut self, index: usize)

Sets the symbol's value's index into the Symbol Data Table

pub fn get_value_index(&self) -> usize

Returns the symbol's value index

pub fn get_section_index(&self) -> usize

Returns the index of the section that this symbol refers to

pub fn to_string(&self) -> String

Returns a string representation of this symbol that is mostly only useful for hashing

Trait Implementations

impl Clone for Symbol

pub fn clone(&self) -> Symbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Hash for Symbol

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.