Struct rbx_dom_weak::SharedString

pub struct SharedString { /* fields omitted */ }

A shared buffer of data that is automatically deduplicated so that only one copy of a given buffer is in memory at a time.

SharedString is cheap to clone, since it's internally reference-counted.

This type was introduced by Roblox to help efficiently store data like CSG operation, which was previously kept as BinaryValue objects in CSGDictionaryService.

rbx_dom_weak's implementation of SharedString tries to be faithful to how SharedString works in Roblox, which unfortunately means that it's keyed by MD5 hash. In the event of a hash collision, one of the involved buffers will be silently discarded. It's possible to diverge from this behavior, but could potentially cause edge-case content compatibility issues.

Methods

impl SharedString

pub fn new(data: Vec<u8>) -> SharedString

Constructs a SharedString from a buffer of data.

If the data is already present in memory as a SharedString, this method will return a reference to it, otherwise it'll be inserted.

pub fn md5_hash(&self) -> [u8; 16]

Returns the MD5 hash of the SharedString, which is used as unique identifier presently barring hash collisions.

pub fn data(&self) -> &[u8]

Returns an immutable reference to the underlying buffer from the SharedString.

Trait Implementations

impl PartialEq<SharedString> for SharedString

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

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

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

This method tests for !=.

impl Drop for SharedString

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for SharedString

impl Clone for SharedString

fn clone(&self) -> SharedString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SharedString

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

Formats the value using the given formatter.

impl Serialize for SharedString

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for SharedString

fn deserialize<D>(deserializer: D) -> Result<SharedString, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.