Enum EntityReference 

pub enum EntityReference {
    Plane {
        plane_id: Uuid,
        topology_fallback: Option<PrimitiveTopologyFallback>,
    },
    Face {
        face_id: Uuid,
        topology_fallback: Option<PrimitiveTopologyFallback>,
    },
    Edge {
        inner: EdgeSpecifier,
        topology_fallback: Option<PrimitiveTopologyFallback>,
    },
    Vertex {
        side_faces: Vec<Uuid>,
        index: Option<u32>,
        topology_fallback: Option<PrimitiveTopologyFallback>,
    },
    Solid2d {
        solid2d_id: Uuid,
        topology_fallback: Option<PrimitiveTopologyFallback>,
    },
    Solid3d {
        solid3d_id: Uuid,
        topology_fallback: Option<PrimitiveTopologyFallback>,
    },
    Solid2dEdge {
        edge_id: Uuid,
        topology_fallback: Option<PrimitiveTopologyFallback>,
    },
    Segment {
        path_id: Uuid,
        segment_id: Uuid,
        topology_fallback: Option<PrimitiveTopologyFallback>,
    },
    Region {
        region_id: Uuid,
        topology_fallback: Option<PrimitiveTopologyFallback>,
    },
}

An edge/vertex can be defined by the faces that it is connected to.

Variants

Plane

A uuid referencing a plane.

Fields

plane_id: Uuid

Id of the plane being referenced.

topology_fallback: Option<PrimitiveTopologyFallback>

Optional primitive topology on a parent (not used for planes today).

Face

A uuid referencing a face.

Fields

face_id: Uuid

Id of the face being referenced.

topology_fallback: Option<PrimitiveTopologyFallback>

Fallback: solid3d UUID + face index on that body when face_id cannot be resolved client-side.

Edge

A collection of ids that uniquely identify an edge.

Fields

inner: EdgeSpecifier

Flattened edge reference (side_faces, end_faces, index).

topology_fallback: Option<PrimitiveTopologyFallback>

Fallback: solid3d UUID + edge index on that body for 3D BREP edges (distinct from inner.index).

Vertex

A collection of ids that uniquely identify an vertex.

Fields

side_faces: Vec<Uuid>

Side face ids that identify the vertex.

index: Option<u32>

Optional index among the filtered candidates.

topology_fallback: Option<PrimitiveTopologyFallback>

Fallback: solid3d UUID + vertex index on that body.

Solid2d

A uuid referencing a solid2d (profile).

Fields

solid2d_id: Uuid

Id of the solid2d being referenced.

topology_fallback: Option<PrimitiveTopologyFallback>

Typically omitted: solid2d_id is already the owning profile. Present for schema parity with other variants.

Solid3d

A uuid referencing a solid3d (body).

Fields

solid3d_id: Uuid

Id of the solid3d being referenced.

topology_fallback: Option<PrimitiveTopologyFallback>

Typically omitted: solid3d_id is already the owning body. Present for schema parity with other variants.

Solid2dEdge

A uuid referencing an edge on a solid2d (profile) - used for raw sketch/profile edges. This is distinct from the face-based Edge reference which is used for BRep/swept body edges.

Fields

edge_id: Uuid

Id of the edge being referenced.

topology_fallback: Option<PrimitiveTopologyFallback>

Fallback: solid2d UUID + curve index in that profile.

Segment

A single segment (curve) within a path.

Fields

path_id: Uuid

Id of the path containing the segment.

segment_id: Uuid

Id of the segment (curve) being referenced.

topology_fallback: Option<PrimitiveTopologyFallback>

Fallback: path UUID + segment curve index.

Region

A closed sketch region/profile area.

Fields

region_id: Uuid

Id of the region being referenced.

topology_fallback: Option<PrimitiveTopologyFallback>

Fallback: path UUID + region index on that path.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for EntityReference

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for EntityReference

fn clone(&self) -> EntityReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntityReference

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EntityReference

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for EntityReference

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for EntityReference

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for EntityReference

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EntityReference

impl TS for EntityReference

type WithoutGenerics = EntityReference

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = EntityReference

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.