interlink 0.1.0-alpha

Framework for writing async code
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

<img src="assets/logo-128.png" width="128" height="auto">


# Interlink


![License](https://img.shields.io/github/license/jacobtread/interlink?style=for-the-badge)
![Cargo Version](https://img.shields.io/crates/v/interlink?style=for-the-badge)
![Cargo Downloads](https://img.shields.io/crates/d/interlink?style=for-the-badge)

*Interlink Async framework*

**Interlink** runs on the [Tokio](https://tokio.rs/) async runtime and structures portions of your
app using "Services" which can be communicated with using "Links" which allow sending messages to
Services that can then be handled

> 🚩 This project is in its very early infantcy so breaking changes are
> expected and at this stage its not entirely feature complete or tested 

## Using Interlink


Adding the following cargo dependency to include interlink in your project

```toml
[dependencies]
interlink = "0.1.0-alpha" 
```

## Starting a service


In order to get a link to a service and for the service to run you will first need to start the service


```rust
use interlink::prelude::*;

// Define your backing structure for the service
struct Example;

// Implement the service trait
impl Service for Example {}

// You must be within the tokio runtime to use interlink
#[tokio::main]

async fn main() {
    // Create the service
    let service = Example {};
    // Start the service to get a link to the service
    let link = service.start();
}

```

## Sending a message to a service


To communicate with services and between services you use messages below
is an example of how to create and send messages.

```rust
use interlink::prelude::*;

// Define your backing structure for the service
struct Example;

// Implement the service trait
impl Service for Example {}

// The message struct
struct TextMessage {
    value: String,
}

// Implement the message trait for messages
impl Message for TextMessage {
    // The type of response from handling this message
    type Response = String;
}

/// Implement a handler for the message type
impl Handler<TextMessage> for Example {
    fn handle(
        &mut self, 
        msg: TextMessage, 
        ctx: &mut ServiceContext<Self>
    ) -> String {
        println!("Got message: {}", &msg.value)
        msg.value
    }
}

// You must be within the tokio runtime to use interlink
#[tokio::main]

async fn main() {
    // Create the service
    let service = Example {};
    // Start the service to get a link to the service
    let link = service.start();

    // Send the text message to the service and await the response
    let res: String = link.send(TextMessage {
            value: "Example".to_string(),
        })
        .await
        .unwrap();

    assert_eq!(&res, "Example");

    // You can also send without waiting for a response
    link.do_send(TextMessage {
            value: "Example".to_string(),
        })
        .unwrap();

}

```