Struct JoinSchema 

pub struct JoinSchema {
    pub next: NextOperation,
    pub buffers: BufferSelection,
    pub clone: Vec<BufferIdentifier<'static>>,
    pub serialize: bool,
    pub trace_settings: TraceSettings,
}

Wait for exactly one item to be available in each buffer listed in buffers, then join each of those items into a single output message that gets sent to next.

If the next operation is not a node type (e.g. fork_clone) then you must specify a target_node so that the diagram knows what data structure to join the values into.

Examples

{
    "version": "0.1.0",
    "start": "begin_measuring",
    "ops": {
        "begin_measuring": {
            "type": "fork_clone",
            "next": ["localize", "imu"]
        },
        "localize": {
            "type": "node",
            "builder": "localize",
            "next": "estimated_position"
        },
        "imu": {
            "type": "node",
            "builder": "imu",
            "config": "velocity",
            "next": "estimated_velocity"
        },
        "estimated_position": { "type": "buffer" },
        "estimated_velocity": { "type": "buffer" },
        "gather_state": {
            "type": "join",
            "buffers": {
                "position": "estimate_position",
                "velocity": "estimate_velocity"
            },
            "next": "report_state"
        },
        "report_state": {
            "type": "node",
            "builder": "publish_state",
            "next": { "builtin": "terminate" }
        }
    }
}

Fields

next: NextOperation

The operation that the joined value will be passed to.

buffers: BufferSelection

Map of buffer keys and buffers.

clone: Vec<BufferIdentifier<'static>>

List of the keys in the buffers dictionary whose value should be cloned instead of removed from the buffer (pulled) when the join occurs. Cloning the value will leave the buffer unchanged after the join operation takes place.

serialize: bool

Whether or not to automatically serialize the inputs into a single JsonMessage. This will only work if all input types are serializable, otherwise you will get a DiagramError.

trace_settings: TraceSettings

Trait Implementations

impl BuildDiagramOperation for JoinSchema

fn build_diagram_operation( &self, _: &OperationName, ctx: &mut DiagramContext<'_, '_, '_, '_, '_>, ) -> Result<BuildStatus, DiagramErrorCode>

impl Clone for JoinSchema

fn clone(&self) -> JoinSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JoinSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JoinSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for JoinSchema

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.