crossbus 0.0.6-a

A Platform-Less Runtime-Less Actor Computing 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
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

#![cfg_attr(not(feature = "std"), no_std)]
#![cfg_attr(docsrs, feature(doc_cfg))]
//! CrossBus is a platform-less runtime-less actor computing model
//!
//! ## Overview
//! [CrossBus](https://github.com/hominee/crossbus) is an implementation of
//! [Actor Computing Model](https://en.wikipedia.org/wiki/Actor_model),
//! with the concept that
//!
//! - **Runtime-less**
//!
//!   crossbus neither provide runtime for app execution
//!   nor access the system interface abstraction.
//!   no built-in runtime, but any runtime is allowed,  
//!   the system-provided / third-party's / that from
//!   `FFI`-binding all work.
//!   Last but not least, even a bare-bone [noop-waker executor](https://docs.rs/futures-task/latest/futures_task/fn.noop_waker.html)
//!   can do.
//!
//!   runtime-located features like `concurrency` and `I/O`
//!   are up to implementor.
//!
//! - **Bare-Metal Compatible**
//!
//!   crossbus links to no std library, no system libraries, no libc,
//!   and a few upstream libraries
//!   enbale you run rust code on bare metal.
//!
//! - **Platform-less by Runtime-less**
//!
//!   take the advantage of runtime-less, crossbus is able to
//!   bypass the limitation of runtime implementor and system
//!   interface abstraction and go right straight to manipulate
//!   task directly.
//!   This is the primary concept of crossbus to run across
//!   many platforms or without platforms.
//!
//! - **Future-oriented Routine and Events**
//!
//!   the futures way to execute task is retained even
//!   without runtime thanks to rust. crossbus defines a set of types
//!   and traits to allow asynchronous tasks manipulation.
//!
//! - **Real-time Execution Control**
//!
//!   taking the advantage of the design of future routine,
//!   each poll and events alongside can be intercepted for
//!   each spawned task during execution, with which more
//!   execution control is possible.
//!

#[macro_use]
extern crate alloc;

pub mod actor;
pub mod address;
pub mod blocker;
pub mod context;
pub mod delayer;
#[cfg(not(feature = "log"))]
#[cfg_attr(docsrs, doc(cfg(not(feature = "log"))))]
#[macro_use]
pub mod log;
pub mod message;
pub(crate) mod queue;
pub mod reactor;
pub mod register;
#[cfg(feature = "rt")]
#[cfg_attr(docsrs, doc(cfg(feature = "rt")))]
pub mod rt;
pub mod stream;
#[cfg(feature = "time")]
#[cfg_attr(docsrs, doc(cfg(feature = "time")))]
pub mod time;

#[cfg(feature = "derive")]
#[cfg_attr(docsrs, doc(cfg(feature = "derive")))]
pub use crossbus_derive::{main, Message};

pub mod prelude {
    //! Some common traits and types

    pub use crate::actor::{ActingState, Actor, ActorId, ActorState, Future};
    pub use crate::address::{Addr, QueueError, Receiver, Sender};
    pub use crate::context::Context;
    pub use crate::reactor::{ReactingOrder, Reactor, ReactorPair};
    pub use crate::register::{ActorRegister, Register};
    #[cfg(feature = "rt")]
    pub use crate::rt::{self, SpawnJoinHandle, Spawning};
    pub use crate::{actor, address, context, message, reactor, register};
    #[cfg(feature = "derive")]
    #[cfg_attr(docsrs, doc(cfg(feature = "derive")))]
    pub use crossbus_derive::{main, Message};
    //pub use crate::blocker::{self, Blocker, BlockerState, Blocking, BlockingState};
    //pub use crate::delayer::{self, Delayer, DelayerState, Delaying, DelayingState};
    //pub use crate::message::{self, MStream, MStreamState, MStreaming, MStreamingState, Message};
    //pub use crate::stream::{self, Stream, StreamState, Streaming, StreamingState};
}