Struct FlowInstance

pub struct FlowInstance {
    pub id: Uuid,
    pub ty: EntityTypeId,
    pub name: String,
    pub description: String,
    pub entity_instances: EntityInstances,
    pub relation_instances: RelationInstances,
}

A flow instance is a container for entity instances and relation instances.

A flow instance is strictly associated with a wrapper entity instance. The properties of the wrapper entity instance are the properties of the flow.

Additionally, flows can be nested - from the perspective of the outer flow the inner flow acts like an entity instance. The wrapper entity instance of the inner flow is the interface which can be accessed by the outer flow.

Entity instances and relation instances can be shared with multiple flows.

It’s even possible to connect entity instances from different flows with relation instances.

Fields

id: Uuid

The id of the flow corresponds to the id of the wrapper entity instance

This means the vector of entity instances must contain an instance with the id of the flow.

ty: EntityTypeId

The type definition of the entity type of the wrapper entity instance.

name: String

The name of the flow instance.

description: String

Textual description of the flow instance.

entity_instances: EntityInstances

The entity instances which are contained in this flow instance.

It can’t have a default because the wrapper entity instance must be present in the list of entities.

relation_instances: RelationInstances

The relation instances which are contained in this flow instance.

By default, no relation instances are contained in this flow instance.

Implementations

impl FlowInstance

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

Create a builder for building FlowInstance. On the builder, call .id(...), .ty(...), .name(...)(optional), .description(...)(optional), .entity_instances(...)(optional), .relation_instances(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of FlowInstance.

impl FlowInstance

pub fn from_instance_with_name<S: Into<String>>( wrapper_entity_instance: EntityInstance, name: S, ) -> FlowInstance

Constructs a new flow instance from the wrapper entity instance.

Trait Implementations

impl Clone for FlowInstance

fn clone(&self) -> FlowInstance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FlowInstance

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FlowInstance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FlowInstance

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

Formats the value using the given formatter.

impl From<EntityInstance> for FlowInstance

fn from(wrapper_entity_instance: EntityInstance) -> FlowInstance

Converts to this type from the input type.

impl FromIterator<FlowInstance> for FlowInstances

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

Creates a value from an iterator.

impl Hash for FlowInstance

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 FlowInstance

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 NamedInstanceContainer for FlowInstance

fn name(&self) -> String

Returns the name of the instance.

fn description(&self) -> String

Returns the description of the instance.

impl NamespacedTypeGetter for FlowInstance

fn namespace(&self) -> String

Returns the namespace of the type.

fn type_name(&self) -> String

Returns the name of the type.

impl Ord for FlowInstance

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<Uuid> for FlowInstance

fn eq(&self, id: &Uuid) -> 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 FlowInstance

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

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 Serialize for FlowInstance

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 FlowInstance

fn type_definition(&self) -> TypeDefinition

Returns the type definition of the type.

impl Eq for FlowInstance

impl StructuralPartialEq for FlowInstance