Struct RelationInstance

pub struct RelationInstance {
    pub outbound_id: Uuid,
    pub ty: RelationInstanceTypeId,
    pub inbound_id: Uuid,
    pub name: String,
    pub description: String,
    pub properties: PropertyInstances,
    pub components: ComponentTypeIds,
    pub extensions: Extensions,
}

Relation instances are edges from an outbound entity instance to an inbound entity instance.

The relation instance is of a relation type. The relation type defines the entity types of the outbound entity instance and the inbound entity instance. Furthermore, the relation type defines which properties (name, data type, socket type) a relation instance have to have.

In contrast to the relation type, the relation instance stores values/ documents in its properties.

Fields

outbound_id: Uuid

The id of the outbound vertex.

ty: RelationInstanceTypeId

The relation instance id is unique and consists of the relation type and an instance_id.

inbound_id: Uuid

The id of the inbound vertex.

name: String

The name of the relation instance.

description: String

Textual description of the relation instance.

properties: PropertyInstances

The properties of then relation instance.

Each property is represented by its name (String) and it’s value. The value is a representation of a JSON. Therefore, the value can be boolean, number, string, array or an object. For more information about the data types please look at https://docs.serde.rs/serde_json/value/enum.Value.html

components: ComponentTypeIds

The components of the entity instance.

extensions: Extensions

Relation instance specific extensions.

Implementations

impl RelationInstance

pub fn builder() -> RelationInstanceBuilder<((), (), (), (), (), (), (), ())>

Create a builder for building RelationInstance. On the builder, call .outbound_id(...), .ty(...), .inbound_id(...), .name(...)(optional), .description(...)(optional), .properties(...)(optional), .components(...)(optional), .extensions(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of RelationInstance.

impl RelationInstance

pub fn new<T: Into<RelationInstanceTypeId>, P: Into<PropertyInstances>>( outbound_id: Uuid, ty: T, inbound_id: Uuid, properties: P, ) -> RelationInstance

Constructs a new relation instance with the given outbound_id, type, inbound_id and properties

pub fn new_from_type_unique_id<S: Into<String>, P: Into<PropertyInstances>>( namespace: S, outbound_id: Uuid, type_name: S, inbound_id: Uuid, properties: P, ) -> RelationInstance

Constructs a new relation instance with the given outbound_id, type, inbound_id and properties

pub fn new_from_type_unique_for_instance_id<S: Into<String>, P: Into<PropertyInstances>>( namespace: S, outbound_id: Uuid, type_name: S, instance_id: S, inbound_id: Uuid, properties: P, ) -> RelationInstance

Constructs a new relation instance with the given outbound_id, type, inbound_id and properties

pub fn new_from_type_with_random_instance_id<S: Into<String>, P: Into<PropertyInstances>>( namespace: S, outbound_id: Uuid, type_name: S, inbound_id: Uuid, properties: P, ) -> RelationInstance

Constructs a new relation instance with the given outbound_id, type, inbound_id and properties

pub fn new_without_properties<T: Into<RelationInstanceTypeId>>( outbound_id: Uuid, ty: T, inbound_id: Uuid, ) -> RelationInstance

Constructs a new relation instance with the given outbound_id, type, inbound_id but without properties

pub fn id(&self) -> RelationInstanceId

Returns the relation instance id.

pub fn relation_type_id(&self) -> RelationTypeId

Returns the inner relation type id.

pub fn instance_id(&self) -> String

Returns the relation instance type id.

Trait Implementations

impl Clone for RelationInstance

fn clone(&self) -> RelationInstance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ComponentTypeIdContainer for RelationInstance

fn is_a(&self, ty: &ComponentTypeId) -> bool

Returns true, if the type is composed with a component of the given type.

fn add_component<C: Into<ComponentTypeId>>(&self, ty: C) -> bool

Adds the given component.

fn add_components<C: Into<ComponentTypeIds>>(&mut self, components_to_add: C)

Adds the given components.

fn remove_component(&self, ty: &ComponentTypeId) -> Option<ComponentTypeId>

Removes the component with the given type id.

fn remove_components<C: Into<ComponentTypeIds>>( &mut self, components_to_remove: C, )

Removes the given components.

fn is_any(&self, component_tys: &ComponentTypeIds) -> bool

Returns true, if the type is composed with any of the given components.

fn is_all(&self, component_tys: &ComponentTypeIds) -> bool

Returns true, if the type is composed with every given components.

impl Debug for RelationInstance

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RelationInstance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RelationInstance

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

Formats the value using the given formatter.

impl ExtensionContainer for RelationInstance

fn has_own_extension(&self, ty: &ExtensionTypeId) -> bool

Returns true, if the container has an extension with the given type.

fn get_own_extension(&self, ty: &ExtensionTypeId) -> Option<Extension>

Returns the own extension with the given type. Doesn’t respect extensions from potential components.

fn add_extension<E: Into<Extension>>( &self, extension: E, ) -> Result<ExtensionTypeId, AddExtensionError>

fn update_extension<T: Into<ExtensionTypeId>, E: Into<Extension>>( &self, ty: T, extension: E, ) -> Result<Extension, UpdateExtensionError>

fn remove_extension<T: Into<ExtensionTypeId>>( &self, ty: T, ) -> Result<Extension, RemoveExtensionError>

fn merge_extensions<E: Into<Extensions>>(&mut self, extensions_to_merge: E)

Merge the given extensions into the own extensions.

fn has_any_own_extensions(&self, tys: &ExtensionTypeIds) -> bool

Returns true, if the type contains any of the given extensions.

fn has_all_own_extensions(&self, tys: &ExtensionTypeIds) -> bool

Returns true, if the type contains all given extensions.

impl FromIterator<RelationInstance> for RelationInstances

fn from_iter<I: IntoIterator<Item = RelationInstance>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for RelationInstance

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for RelationInstance

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

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 inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn always_inline_schema() -> bool

👎Deprecated: Use inline_schema() instead

Only included for backward-compatibility - use inline_schema() instead“.

impl MutablePropertyInstanceSetter for RelationInstance

fn set<S: Into<String>>(&mut self, property_name: S, value: Value)

Sets the value of the given property by name

impl NamedInstanceContainer for RelationInstance

fn name(&self) -> String

Returns the name of the instance.

fn description(&self) -> String

Returns the description of the instance.

impl NamespacedTypeGetter for RelationInstance

fn namespace(&self) -> String

Returns the namespace of the type.

fn type_name(&self) -> String

Returns the name of the type.

impl Ord for RelationInstance

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,

Restrict a value to a certain interval.

impl PartialEq<RelationInstanceId> for RelationInstance

fn eq(&self, id: &RelationInstanceId) -> 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 PartialEq for RelationInstance

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PropertyInstanceGetter for RelationInstance

fn get<S: Into<String>>(&self, property_name: S) -> Option<Value>

Returns the json value of the given property by name

fn as_bool<S: Into<String>>(&self, property_name: S) -> Option<bool>

Returns the boolean value of the given property by name

fn as_u64<S: Into<String>>(&self, property_name: S) -> Option<u64>

Returns the u64 value of the given property by name

fn as_i64<S: Into<String>>(&self, property_name: S) -> Option<i64>

Returns the i64 value of the given property by name

fn as_f64<S: Into<String>>(&self, property_name: S) -> Option<f64>

Returns the f64 value of the given property by name

fn as_string<S: Into<String>>(&self, property_name: S) -> Option<String>

Returns the string value of the given property by name

fn as_array<S: Into<String>>(&self, property_name: S) -> Option<Vec<Value>>

Returns the string value of the given property by name

fn as_object<S: Into<String>>( &self, property_name: S, ) -> Option<Map<String, Value>>

Returns the string value of the given property by name

impl Serialize for RelationInstance

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TypeDefinitionGetter for RelationInstance

fn type_definition(&self) -> TypeDefinition

Returns the type definition of the type.

impl Eq for RelationInstance

impl StructuralPartialEq for RelationInstance