Struct typedb_driver::concept::RelationType

pub struct RelationType {
    pub label: String,
    pub is_root: bool,
    pub is_abstract: bool,
}

Relation types (or subtypes of the relation root type) represent relationships between types. Relation types have roles.

Other types can play roles in relations if it’s mentioned in their definition.

A relation type must specify at least one role.

Fields

label: String

is_root: bool

is_abstract: bool

Implementations

impl RelationType

pub fn root() -> Self

Returns the root RelationType

Trait Implementations

impl Clone for RelationType

fn clone(&self) -> RelationType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RelationType

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

Formats the value using the given formatter.

impl PartialEq for RelationType

fn eq(&self, other: &RelationType) -> 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 RelationTypeAPI for RelationType

fn create<'tx>( &self, transaction: &'tx Transaction<'_> ) -> BoxPromise<'tx, Result<Relation>>

Creates and returns an instance of this RelationType.

fn get_supertype<'tx>( &self, transaction: &'tx Transaction<'_> ) -> BoxPromise<'tx, Result<Option<RelationType>>>

Retrieves the most immediate supertype of the RelationType.

fn set_supertype<'tx>( &mut self, transaction: &'tx Transaction<'_>, supertype: RelationType ) -> BoxPromise<'tx, Result>

Sets the supplied RelationType as the supertype of the current RelationType.

fn get_supertypes<'tx>( &self, transaction: &'tx Transaction<'_> ) -> Result<BoxStream<'tx, Result<RelationType>>>

Retrieves all supertypes of the RelationType.

fn get_subtypes<'tx>( &self, transaction: &'tx Transaction<'_>, transitivity: Transitivity ) -> Result<BoxStream<'tx, Result<RelationType>>>

Retrieves all direct and indirect (or direct only) subtypes of the RelationType.

fn get_instances<'tx>( &self, transaction: &'tx Transaction<'_>, transitivity: Transitivity ) -> Result<BoxStream<'tx, Result<Relation>>>

Retrieves all direct and indirect (or direct only) Relations that are instances of this RelationType.

fn get_relates<'tx>( &self, transaction: &'tx Transaction<'_>, transitivity: Transitivity ) -> Result<BoxStream<'tx, Result<RoleType>>>

Retrieves roles that this RelationType relates to directly or via inheritance.

fn get_relates_for_role_label<'tx>( &self, transaction: &'tx Transaction<'_>, role_label: String ) -> BoxPromise<'tx, Result<Option<RoleType>>>

Retrieves role with a given role_label that this RelationType relates to.

fn get_relates_overridden<'tx>( &self, transaction: &'tx Transaction<'_>, overridden_role_label: String ) -> BoxPromise<'tx, Result<Option<RoleType>>>

Retrieves a RoleType that is overridden by the role with the overridden_role_label.

fn set_relates<'tx>( &mut self, transaction: &'tx Transaction<'_>, role_label: String, overridden_role_label: Option<String> ) -> BoxPromise<'tx, Result>

Sets the new role that this RelationType relates to. If we are setting an overriding type this way, we have to also pass the overridden type as a second argument.

fn unset_relates<'tx>( &mut self, transaction: &'tx Transaction<'_>, role_label: String ) -> BoxPromise<'tx, Result>

Disallows this RelationType from relating to the given role.

impl ThingTypeAPI for RelationType

fn label(&self) -> &str

Retrieves the unique label of the type.

fn is_abstract(&self) -> bool

Checks if the type is prevented from having data instances (i.e. abstract).

fn is_root(&self) -> bool

Checks if the type is a root type.

fn to_thing_type_cloned(&self) -> ThingType

fn is_deleted<'tx>( &self, transaction: &'tx Transaction<'_> ) -> BoxPromise<'tx, Result<bool>>

Checks if this type is deleted.

fn delete<'tx>( &mut self, transaction: &'tx Transaction<'_> ) -> BoxPromise<'tx, Result>

Deletes this type from the database.

fn set_label<'tx>( &mut self, transaction: &'tx Transaction<'_>, new_label: String ) -> BoxPromise<'tx, Result>

Renames the label of the type. The new label must remain unique.

fn set_abstract<'tx>( &mut self, transaction: &'tx Transaction<'_> ) -> BoxPromise<'tx, Result>

Set a type to be abstract, meaning it cannot have instances.

fn unset_abstract<'tx>( &mut self, transaction: &'tx Transaction<'_> ) -> BoxPromise<'tx, Result>

Set a type to be non-abstract, meaning it can have instances.

fn get_owns<'tx>( &self, transaction: &'tx Transaction<'_>, value_type: Option<ValueType>, transitivity: Transitivity, annotations: Vec<Annotation> ) -> Result<BoxStream<'tx, Result<AttributeType>>>

Retrieves AttributeType that the instances of this ThingType are allowed to own directly or via inheritance.

fn get_owns_overridden<'tx>( &self, transaction: &'tx Transaction<'_>, overridden_attribute_type: AttributeType ) -> BoxPromise<'tx, Result<Option<AttributeType>>>

Retrieves an AttributeType, ownership of which is overridden for this ThingType by a given attribute_type.

fn set_owns<'tx>( &mut self, transaction: &'tx Transaction<'_>, attribute_type: AttributeType, overridden_attribute_type: Option<AttributeType>, annotations: Vec<Annotation> ) -> BoxPromise<'tx, Result>

Allows the instances of this ThingType to own the given AttributeType.

fn unset_owns<'tx>( &mut self, transaction: &'tx Transaction<'_>, attribute_type: AttributeType ) -> BoxPromise<'tx, Result>

Disallows the instances of this ThingType from owning the given AttributeType.

fn get_plays<'tx>( &self, transaction: &'tx Transaction<'_>, transitivity: Transitivity ) -> Result<BoxStream<'tx, Result<RoleType>>>

Retrieves all direct and inherited (or direct only) roles that are allowed to be played by the instances of this ThingType.

fn get_plays_overridden<'tx>( &self, transaction: &'tx Transaction<'_>, overridden_role_type: RoleType ) -> BoxPromise<'tx, Result<Option<RoleType>>>

Retrieves a RoleType that is overridden by the given role_type for this ThingType.

fn set_plays<'tx>( &mut self, transaction: &'tx Transaction<'_>, role_type: RoleType, overridden_role_type: Option<RoleType> ) -> BoxPromise<'tx, Result>

Allows the instances of this ThingType to play the given role.

fn unset_plays<'tx>( &mut self, transaction: &'tx Transaction<'_>, role_type: RoleType ) -> BoxPromise<'tx, Result>

Disallows the instances of this ThingType from playing the given role.

fn get_syntax<'tx>( &self, transaction: &'tx Transaction<'_> ) -> BoxPromise<'tx, Result<String>>

Produces a pattern for creating this ThingType in a define query.

impl Eq for RelationType

impl StructuralEq for RelationType

impl StructuralPartialEq for RelationType