Browse Source

Update docs/src/rust-api.md

Co-authored-by: Philipp Oppermann <dev@phil-opp.com>
tags/v0.2.0-rc
Haixuan Xavier Tao GitHub 3 years ago
parent
commit
13fd3ad022
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
  1. +1
    -1
      docs/src/rust-api.md

+ 1
- 1
docs/src/rust-api.md View File

@@ -4,7 +4,7 @@

The operator API is a framework for you to implement. The implemented operator will be managed by `dora`. This framework enable us to make optimisation and provide advanced features. It is the recommended way of using `dora`.

An operator requires to be registered and implement the `DoraOperator` trait. It is composed of an `on_event` method that defines the behaviour of the operator when there is an event such as receiving an input for exemple.
An operator requires to be registered and implement the `DoraOperator` trait. It is composed of an `on_event` method that defines the behaviour of the operator when there is an event such as receiving an input for example.

```rust
{{#include ../../examples/rust-dataflow/operator/src/lib.rs:0:17}}


Loading…
Cancel
Save