rbx_reflection_database

More details about this crate are available on the rbx-dom GitHub.

Contains an API to get a Roblox reflection database using the types from rbx_reflection. This crate embeds a database for this purpose, but also provides an API for dependents to get a reflection database from a consistent location.

The general way this crate should be used is via get. This method will search for a locally stored reflection database and return it if it's found. If it isn't, it will instead return the bundled one. The details for where it searches are below.

Additionally, this crate exposes get_local and get_bundled for only loading the locally stored database or only the bundled one respectively.

Local Details

This crate will load a reflection database from the file system if one exists in the default location. This location varies upon the OS and is specified here:

Additionally, a location override may be specified via the RBX_DATABASE environment variable. The RBX_DATABASE variable points to the override database.msgpack file, not to an override .rbxreflection directory.

Both the default database.msgpack files and any files pointed to by RBX_DATABASE must be valid MessagePack serializations of a ReflectionDatabase if they're present.