logic-mesh 1.0.0

Control logic engine using event based and reactive blocks written in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

// Copyright (c) 2022-2023, Radu Racariu.

//!
//! Defines the base output properties.
//!

use libhaystack::val::{Value, kind::HaystackKind};
use uuid::Uuid;

use crate::base::link::Link;

/// The description of an output pin
#[derive(Debug, Default, Clone)]
pub struct OutDesc {
    /// The output's name
    pub name: String,
    /// The output's haystack kind
    pub kind: HaystackKind,
}

/// Properties of a block output pin
pub trait OutputProps {
    /// The output's description
    fn desc(&self) -> &OutDesc;

    /// The output's name
    fn name(&self) -> &str {
        &self.desc().name
    }

    /// The block id of the block this output belongs to
    fn block_id(&self) -> &Uuid;

    /// True if this output is connected to at least one input
    fn is_connected(&self) -> bool;

    /// Get a list of links to this output. The trait objects carry a
    /// `+ Send` bound so they can be held across `.await` points in the
    /// MT actor future.
    fn links(&self) -> Vec<&(dyn Link + Send)>;

    /// Remove a link from this output
    /// # Arguments
    /// - link: The link to be removed
    fn remove_link(&mut self, link: &dyn Link) {
        self.remove_link_by_id(link.id())
    }

    /// Remove a link by id from this output
    /// # Arguments
    /// - link_id: The id of the link to be removed
    fn remove_link_by_id(&mut self, link_id: &Uuid);

    /// Remove all links to a specific block from this output
    fn remove_target_block_links(&mut self, block_id: &Uuid);

    /// Remove all links from this output
    fn remove_all_links(&mut self);

    /// Get this output's value
    fn value(&self) -> &Value;
}