kompact 0.12.0

Kompact is a Rust implementation of the Kompics component model combined with the Actor model.
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

Kompact
=======

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/kompics/kompact)
[![Cargo](https://img.shields.io/crates/v/kompact.svg)](https://crates.io/crates/kompact)
[![Documentation](https://docs.rs/kompact/badge.svg)](https://docs.rs/kompact)
[![codecov](https://codecov.io/gh/kompics/kompact/branch/master/graph/badge.svg?token=NKH34R0CRC)](https://codecov.io/gh/kompics/kompact)
![Build Status](https://github.com/kompics/kompact/workflows/CI/badge.svg)

Kompact is an in-development message-passing component system like [Kompics](https://kompics.github.io/docs/current/) in the Rust language, with performance and static typing in mind. It merges both Kompics' component model and the actor model as found in [Erlang](http://www.erlang.se/) or [Akka](https://akka.io/).

Kompact has [shown](https://kompics.github.io/kompicsbenches/) itself to vastly outperform many of its peers on a wide range of message-passing tasks, providing the capability of handling up to 400mio messages per second on 36 cores.

Kompact comes with its own network library built-in, providing easy connection maintenance and efficient serialisation for distributed deployments.

## Documentation

For reference and short examples check the [API Docs](https://docs.rs/kompact).

A thorough introduction with many longer examples can be found in the [tutorial](https://kompics.github.io/kompact/). The examples themselves can be found in the [docs/examples](docs/examples) folder.

#### Rust Version

Kompact before `v0.9.0` requires Rust `nightly`.

Since `v0.9.0` Kompact can be built on stable Rust, with a slightly different API.

## Build And Test

Use the split test plan when testing the full repository:

```bash
cargo test --workspace --exclude kompact-net --exclude kompact-examples-local --exclude kompact-examples-net
cargo test -p kompact-examples-local
cargo test -p kompact-net
cargo test -p kompact-examples-net
```

This keeps the local-only examples and other local actor tests in a non-distributed build. Cargo unifies features across all selected workspace members, and `kompact-net` and the network examples enable Kompact's distributed support. When local-only actors are selected in the same Cargo command as those crates, they are compiled against the distributed `Actor` trait, where `receive_network` is part of the required API.

The repository also provides a helper script for this:

```bash
./run_tests.sh
```

Run the Clippy checks with the same feature-compatible split used by CI:

```bash
./run_checks.sh
```

## License

Licensed under the terms of MIT license.

See [LICENSE](LICENSE) for details.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Kompact by you shall be licensed as MIT, without any additional terms or conditions.