Struct Categories

pub struct Categories { /* private fields */ }

A (named) object which is used to indicate which categorical data types have the same mapping.

Implementations

impl Categories

pub fn new( name: PlSmallStr, namespace: PlSmallStr, physical: CategoricalPhysical, ) -> Arc<Categories>

Creates a new Categories object with the given name, namespace and physical type if none exists, otherwise get a reference to an existing object with the same name, namespace and physical type.

pub fn global() -> Arc<Categories>

Returns the global Categories.

pub fn is_global(self: &Arc<Categories>) -> bool

Returns whether this refers to the global categories.

pub fn random( namespace: PlSmallStr, physical: CategoricalPhysical, ) -> Arc<Categories>

Generates a Categories with a random (UUID) name.

pub fn name(&self) -> &PlSmallStr

The name of this Categories object.

pub fn namespace(&self) -> &PlSmallStr

The namespace of this Categories object.

pub fn physical(&self) -> CategoricalPhysical

The physical dtype of the category ids.

pub fn hash(&self) -> u64

A stable hash of this Categories object, not the contained categories.

pub fn mapping(&self) -> Arc<CategoricalMapping>

The mapping for this Categories object. If no mapping currently exists it creates a new empty mapping.

pub fn freeze(&self) -> Arc<FrozenCategories>

Trait Implementations

impl Debug for Categories

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Drop for Categories

fn drop(&mut self)

Executes the destructor for this type.