Struct re_types_builder::Object

pub struct Object {
    pub virtpath: String,
    pub filepath: Utf8PathBuf,
    pub fqname: String,
    pub pkg_name: String,
    pub name: String,
    pub docs: Docs,
    pub kind: ObjectKind,
    pub attrs: Attributes,
    pub fields: Vec<ObjectField>,
    pub class: ObjectClass,
    pub datatype: Option<LazyDatatype>,
}

A high-level representation of a flatbuffers object, which can be either a struct, a union or an enum.

Fields

virtpath: String

Utf8Path of the associated fbs definition in the Flatbuffers hierarchy, e.g. //rerun/components/point2d.fbs.

filepath: Utf8PathBuf

Absolute filepath of the associated fbs definition.

fqname: String

Fully-qualified name of the object, e.g. rerun.components.Position2D.

pkg_name: String

Fully-qualified package name of the object, e.g. rerun.components.

name: String

PascalCase name of the object type, e.g. Position2D.

docs: Docs

The object’s multiple layers of documentation.

kind: ObjectKind

The object’s kind: datatype, component or archetype.

attrs: Attributes

The object’s attributes.

fields: Vec<ObjectField>

The object’s inner fields, which can be either struct members or union/emum variants.

These are ordered using their order attribute (structs), or in the same order that they appeared in the .fbs (enum/union).

class: ObjectClass

struct, enum, or union?

datatype: Option<LazyDatatype>

The Arrow datatype of this Object, or None if the object is Arrow-transparent.

This is lazily computed when the parent object gets registered into the Arrow registry and will be None until then.

Implementations

impl Object

pub fn from_raw_object( reporter: &Reporter, include_dir_path: impl AsRef<Utf8Path>, enums: &[FbsEnum<'_>], objs: &[FbsObject<'_>], obj: &FbsObject<'_>, ) -> Self

Resolves a raw crate::Object into a higher-level representation that can be easily interpreted and manipulated.

pub fn from_raw_enum( reporter: &Reporter, include_dir_path: impl AsRef<Utf8Path>, enums: &[FbsEnum<'_>], objs: &[FbsObject<'_>], enm: &FbsEnum<'_>, ) -> Self

Resolves a raw FbsEnum into a higher-level representation that can be easily interpreted and manipulated.

pub fn get_attr<T>(&self, name: impl AsRef<str>) -> T

where T: FromStr, T::Err: Error + Send + Sync + 'static,

pub fn try_get_attr<T>(&self, name: impl AsRef<str>) -> Option<T>

where T: FromStr, T::Err: Error + Send + Sync + 'static,

pub fn is_attr_set(&self, name: impl AsRef<str>) -> bool

pub fn archetype_view_types(&self) -> Option<Vec<ViewReference>>

pub fn is_struct(&self) -> bool

pub fn is_enum(&self) -> bool

pub fn is_union(&self) -> bool

pub fn is_arrow_transparent(&self) -> bool

fn is_transparent(&self) -> bool

pub fn has_default_destructor(&self, objects: &Objects) -> bool

Is the destructor trivial/default (i.e. is this simple data with no allocations)?

pub fn relative_filepath(&self) -> Option<&Utf8Path>

Try to find the relative file path of the .fbs source file.

pub fn snake_case_name(&self) -> String

The snake_case name of the object, e.g. translation_and_mat3x3.

pub fn is_testing(&self) -> bool

Returns true if this object is part of testing and not to be used in the production SDK.

pub fn scope(&self) -> Option<String>

pub fn deprecation_notice(&self) -> Option<String>

pub fn is_experimental(&self) -> bool

pub fn doc_category(&self) -> Option<String>

pub fn crate_name(&self) -> String

Returns the crate name of an object, accounting for overrides.

pub fn module_name(&self) -> String

Returns the module name of an object.

pub fn is_archetype(&self) -> bool

Trait Implementations

impl Clone for Object

fn clone(&self) -> Object

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CppObjectExtensions for Object

fn namespace_ident(&self) -> Ident

fn ident(&self) -> Ident

impl Debug for Object

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

Formats the value using the given formatter.

impl Ord for Object

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Object

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Object

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PythonObjectExt for Object

fn is_delegating_component(&self) -> bool

Returns true if the object is a delegating component.

fn is_non_delegating_component(&self) -> bool

Returns true if the object is a non-delegating component.

fn delegate_datatype<'a>(&self, objects: &'a Objects) -> Option<&'a Object>

If the object is a delegating component, returns the datatype it delegates to.

impl Eq for Object