Struct DoraNode

pub struct DoraNode { /* private fields */ }

Implementations

impl DoraNode

pub fn init_from_env() -> Result<(Self, EventStream)>

Initiate a node from environment variables set by dora-coordinator

use dora_node_api::DoraNode;

let (mut node, mut events) = DoraNode::init_from_env().expect("Could not init node.");

pub fn init_from_node_id(node_id: NodeId) -> Result<(Self, EventStream)>

Initiate a node from a dataflow id and a node id.

use dora_node_api::DoraNode;
use dora_node_api::dora_core::config::NodeId;

let (mut node, mut events) = DoraNode::init_from_node_id(NodeId::from("plot".to_string())).expect("Could not init node plot");

pub fn init_flexible(node_id: NodeId) -> Result<(Self, EventStream)>

pub fn init(node_config: NodeConfig) -> Result<(Self, EventStream)>

pub fn send_output_raw<F>( &mut self, output_id: DataId, parameters: MetadataParameters, data_len: usize, data: F, ) -> Result<()>

where F: FnOnce(&mut [u8]),

Send data from the node to the other nodes. We take a closure as an input to enable zero copy on send.

use dora_node_api::{DoraNode, MetadataParameters};
use dora_core::config::DataId;

let (mut node, mut events) = DoraNode::init_from_env().expect("Could not init node.");

let output = DataId::from("output_id".to_owned());

let data: &[u8] = &[0, 1, 2, 3];
let parameters = MetadataParameters::default();

node.send_output_raw(
   output,
   parameters,
   data.len(),
   |out| {
        out.copy_from_slice(data);
    }).expect("Could not send output");

pub fn send_output( &mut self, output_id: DataId, parameters: MetadataParameters, data: impl Array, ) -> Result<()>

pub fn send_output_bytes( &mut self, output_id: DataId, parameters: MetadataParameters, data_len: usize, data: &[u8], ) -> Result<()>

pub fn send_typed_output<F>( &mut self, output_id: DataId, type_info: ArrowTypeInfo, parameters: MetadataParameters, data_len: usize, data: F, ) -> Result<()>

where F: FnOnce(&mut [u8]),

pub fn send_output_sample( &mut self, output_id: DataId, type_info: ArrowTypeInfo, parameters: MetadataParameters, sample: Option<DataSample>, ) -> Result<()>

pub fn close_outputs(&mut self, outputs: Vec<DataId>) -> Result<()>

pub fn id(&self) -> &NodeId

pub fn dataflow_id(&self) -> &DataflowId

pub fn node_config(&self) -> &NodeRunConfig

pub fn allocate_data_sample(&mut self, data_len: usize) -> Result<DataSample>

pub fn dataflow_descriptor(&self) -> Result<&Descriptor>

Returns the full dataflow descriptor that this node is part of.

This method returns the parsed dataflow YAML file.

Trait Implementations

impl Drop for DoraNode

fn drop(&mut self)

Executes the destructor for this type.