Bastion Documentation and New project logos

bastion/examples/getting_started.rs

@@ -109,7 +109,7 @@ fn main() {
     let answer: Answer = child
         .ask("A message containing data.")
         .expect("Couldn't send the message.");
-    async {
+    let _ = async {
         // ...until the child eventually answers back...
         let _answer: Result<Msg, ()> = answer.await;
     };

bastion/src/children.rs

@@ -1,3 +1,6 @@
+//!
+//! Children are a group of child supervised under a supervisor
+//! Allows users to communicate with children through the mailboxes.
 use crate::broadcast::{Broadcast, Parent, Sender};
 use crate::context::{BastionContext, BastionId, ContextState};
 use crate::message::{Answer, BastionMessage, Message};

bastion/src/context.rs

@@ -11,6 +11,31 @@ pub(crate) const NIL_ID: BastionId = BastionId(Uuid::nil());
 #[derive(Hash, Eq, PartialEq, Debug, Clone)]
 pub(crate) struct BastionId(Uuid);
 
+///
+/// Context for the inter children communication.
+///
+/// # Example
+///
+/// ```rust
+/// # use bastion::prelude::*;
+/// #
+/// # fn main() {
+///     # Bastion::init();
+///     #
+/// Bastion::children(|children| {
+///     children.with_exec(|ctx: BastionContext| {
+///         async move {
+///             format!("{:#?}", ctx.current());
+///             Ok(())
+///         }
+///     })
+/// }).expect("Couldn't create the children group.");
+///     #
+///     # Bastion::start();
+///     # Bastion::stop();
+///     # Bastion::block_until_stopped();
+/// # }
+/// ```
 #[derive(Debug)]
 pub struct BastionContext {
     id: BastionId,

bastion/src/lib.rs

@@ -9,14 +9,7 @@
 //! called [lightproc] and utilize all the system resources
 //! efficiently with at-most-once message delivery guarantee.
 //!
-//! ## Why Bastion?
-//! If one of the questions below answered with yes, then Bastion is just for you:
-//! * Do I need fault-tolerance in my project?
-//! * Do I hate to implement weird Actor traits?
-//! * I shouldn't need a webserver to run an actor system, right?
-//! * Do I want to make my existing code unbreakable?
-//! * Do I need an executor which is using system resources efficiently?
-//! * Do I have some trust issues against orchestration systems? Because I want to implement my own application lifecycle.
+//! To have a quick start please head to: [Bastion System Documentation](struct.Bastion.html).
 //!
 //! ## Features
 //! * Message-based communication makes this project a lean mesh of actor system.
@@ -31,10 +24,24 @@
 //! ## Guarantees
 //! * At most once delivery for all the messages.
 //! * Completely asynchronous system design.
-//! * Asynchronous program boundaries
-//! *
+//! * Asynchronous program boundaries with [fort].
+//! * Dynamic supervision of supervisors (adding a subtree later during the execution)
+//! * Lifecycle management both at `futures` and `lightproc` layers.
+//! * Faster middleware development.
+//! * Above all "fault-tolerance".
+//!
+//! ## Why Bastion?
+//! If one of the questions below answered with yes, then Bastion is just for you:
+//! * Do I need fault-tolerance in my project?
+//! * Do I need to write resilient middleware/s?
+//! * I shouldn't need a webserver to run an actor system, right?
+//! * Do I want to make my existing code unbreakable?
+//! * Do I need an executor which is using system resources efficiently?
+//! * Do I have some trust issues against orchestration systems? Because I want to implement my own application lifecycle.
+//!
 //!
 //! [lightproc]: https://docs.rs/lightproc/
+//! [fort]: https://docs.rs/fort/
 //!
 
 #![doc(
@@ -55,6 +62,8 @@ pub mod children;
 pub mod message;
 pub mod supervisor;
 
+///
+/// Prelude of Bastion
 pub mod prelude {
     pub use crate::bastion::Bastion;
     pub use crate::children::{ChildRef, Children, ChildrenRef};

bastion/src/message.rs

@@ -1,3 +1,11 @@
+//!
+//! Dynamic dispatch oriented messaging system
+//!
+//! This system allows:
+//! * Generic communication between mailboxes.
+//! * All message communication relies on at-most-once delivery guarantee.
+//! * Messages are not guaranteed to be ordered, all message's order is causal.
+//!
 use crate::children::Children;
 use crate::context::BastionId;
 use crate::supervisor::{SupervisionStrategy, Supervisor};

bastion/src/supervisor.rs

@@ -1,3 +1,6 @@
+//!
+//! Supervisors enable users to supervise a subtree of children
+//! or other supervisor trees under themselves.
 use crate::broadcast::{Broadcast, Parent, Sender};
 use crate::children::{Children, ChildrenRef};
 use crate::context::BastionId;