Struct Decoder

pub struct Decoder;

Implementations

impl Decoder

pub fn decode_dictionary(bytes: &[u8]) -> Result<GodotDictionary>

Decodes bytes into a godot dictionary.

Example

// Typically you would get this from a network request
let bytes = /* Pretend we have valid bytes here */

let Ok(dictionary) = Decoder::decode_dictionary(&bytes) else {
    panic!("Invalid bytes");
}

// Assuming the dictionary has a key value pair that has a key of "position"
let key = Box::new(GodotString::new("position")) as Box<dyn GodotVariant>;

// We can get the value now with this key
let value = dictionary.map.get(&key);

impl Decoder

pub fn decode_float(bytes: &[u8], flag: &SerializeFlag) -> Result<GodotFloat>

Decodes a bytes into a Godot float

pub fn decode_raw_float( bytes: &[u8], offset: usize, flag: &SerializeFlag, ) -> Result<GodotFloat>

Uses a serialization flag and the offset in bytes to decode bytes into a Godot float

impl Decoder

pub fn decode_int(bytes: &[u8], flag: &SerializeFlag) -> Result<GodotInteger>

Decodes bytes into a Godot integer

pub fn decode_raw_int( bytes: &[u8], offset: usize, flag: &SerializeFlag, ) -> Result<GodotInteger>

Uses a serialization flag and the offset in bytes to decode bytes into a Godot integer

impl Decoder

pub fn decode_string(bytes: &[u8]) -> Result<GodotString>

Decodes bytes into a Godot string. This will fail if the bytes do not match Godot’s serialization rules

impl Decoder

pub fn decode_vector2(bytes: &[u8]) -> Result<GodotVector2>

Decodes bytes into a vector 2. This will fail if the inner bytes can’t be decoded into a float

pub fn decode_vector3(bytes: &[u8]) -> Result<GodotVector3>

Decodes bytes into a vector 3. This will fail if the inner bytes can’t be decoded into a float

impl Decoder

pub fn decode_bool(bytes: &[u8], flag: &SerializeFlag) -> Result<GodotBool>

Decodes bytes into a Godot bool

impl Decoder

pub fn get_type_and_flags( bytes: &[u8], ) -> Result<(GodotTypeIndex, SerializeFlag)>

Gets the type and flags of the bytes passed. The type determines which type we should try and decode it as, and the flag shows how we will decode the type

pub fn decode_variant(bytes: &[u8]) -> Result<Box<dyn GodotVariant + 'static>>

Decodes bytes into it’s respective Godot variant. This can fail if the bytes does not match Godot’s serialization rules or it’s an unsupported type.