Struct rbx_binary::Deserializer

pub struct Deserializer<'db> { /* private fields */ }

A configurable deserializer for Roblox binary models and places.

Example

use std::fs::File;
use std::io::BufReader;

use rbx_binary::Deserializer;

let input = BufReader::new(File::open("File.rbxm")?);

let deserializer = Deserializer::new();
let dom = deserializer.deserialize(input)?;

// rbx_binary always returns a DOM with a DataModel at the top level.
// To get to the instances from our file, we need to go one level deeper.

println!("Root instances in file:");
for &referent in dom.root().children() {
    let instance = dom.get_by_ref(referent).unwrap();
    println!("- {}", instance.name);
}

Configuration

A custom ReflectionDatabase can be specified via reflection_database.

Implementations

impl<'db> Deserializer<'db>

pub fn new() -> Self

Create a new Deserializer with the default settings.

pub fn reflection_database(self, database: &'db ReflectionDatabase<'db>) -> Self

Sets what reflection database for the deserializer to use.

pub fn deserialize<R: Read>(&self, reader: R) -> Result<WeakDom, Error>

Deserialize a Roblox binary model or place from the given stream using this deserializer.

Trait Implementations

impl<'db> Default for Deserializer<'db>

fn default() -> Self

Returns the “default value” for a type.