Struct magnus::r_typed_data::DataTypeBuilder

pub struct DataTypeBuilder<T> { /* private fields */ }

A builder for DataType.

Implementations

impl<T> DataTypeBuilder<T>where
    T: DataTypeFunctions,

pub fn new(name: &'static str) -> Self

Create a new DataTypeBuilder.

name should be unique per wrapped type. It does not need to be a valid Ruby identifier.

pub fn mark(&mut self)

Enable using the the mark function from <T as DataTypeFunctions>.

pub fn size(&mut self)

Enable using the the size function from <T as DataTypeFunctions>.

pub fn compact(&mut self)

Enable using the the compact function from <T as DataTypeFunctions>.

pub fn free_immediately(&mut self)

Enable the ‘free_immediately’ flag.

This is safe to do as long as the <T as DataTypeFunctions>::free function or T’s drop function don’t call Ruby in any way.

If safe this should be enabled as this performs better and is more memory efficient.

pub fn wb_protected(&mut self)

Enable the ‘write barrier protected’ flag.

You almost certainly don’t want to enable this.

pub fn frozen_shareable(&mut self)

Enable the ‘frozen_shareable’ flag.

Set this if your type is thread safe when the Ruby wrapper object is frozen.

pub fn build(self) -> DataType

Consume the builder and create a DataType.