Struct Flow 

pub struct Flow { /* private fields */ }

Represents a transfer of a resource between two entities.

Flows are the “MOVEMENT” in enterprise models - they capture the transfer of resources from one entity to another.

Examples

use sea_core::primitives::{Entity, Resource, Flow};
use sea_core::units::unit_from_string;
use rust_decimal::Decimal;

let warehouse = Entity::new_with_namespace("Warehouse".to_string(), "default".to_string());
let factory = Entity::new_with_namespace("Factory".to_string(), "default".to_string());
let product = Resource::new_with_namespace("Widget", unit_from_string("units"), "default".to_string());

let flow = Flow::new(
    product.id().clone(),
    warehouse.id().clone(),
    factory.id().clone(),
    Decimal::from(100)
);

assert_eq!(flow.quantity(), Decimal::from(100));

Implementations

impl Flow

pub fn new( resource_id: ConceptId, from_id: ConceptId, to_id: ConceptId, quantity: Decimal, ) -> Self

Creates a new Flow using the default namespace.

pub fn new_with_namespace( resource_id: ConceptId, from_id: ConceptId, to_id: ConceptId, quantity: Decimal, namespace: impl Into<String>, ) -> Self

Creates a new Flow with namespace.

pub fn id(&self) -> &ConceptId

pub fn resource_id(&self) -> &ConceptId

pub fn from_id(&self) -> &ConceptId

pub fn to_id(&self) -> &ConceptId

pub fn quantity(&self) -> Decimal

pub fn namespace(&self) -> &str

pub fn set_attribute(&mut self, key: impl Into<String>, value: Value)

pub fn get_attribute(&self, key: &str) -> Option<&Value>

pub fn attributes(&self) -> &HashMap<String, Value>

Returns all attributes as a reference.

Trait Implementations

impl Clone for Flow

fn clone(&self) -> Flow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Flow

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Flow

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Flow

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

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 Flow