feat(rust): ockam_core crate v0.4.0

Author: Jared Stanbrough

implementations/rust/ockam/ockam/Cargo.lock

@@ -25,7 +25,7 @@ no_std = ["ockam_core/no_std", "serde"]
 bbs = { version = "0.4", optional = true }
 digest = { version = "0.8", optional = true }
 ff = { version = "0.6", package = "ff-zeroize", optional = true }
-ockam_core = {path = "../ockam_core", version = "0.3.0"}
+ockam_core = {path = "../ockam_core", version = "0.4.0"}
 ockam_node = {path = "../ockam_node", version = "0.2.0", optional = true}
 ockam_node_attribute = {path = "../ockam_node_attribute", version = "0.1.3"}
 ockam_vault_core = {path = "../ockam_vault_core", version = "0.2.0"}

implementations/rust/ockam/ockam/Cargo.toml

@@ -5,6 +5,16 @@ All notable changes to this crate will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v0.4.0 - 2021-03-03
+### Added
+
+- Auto-implemenation of the `Message` trait for certain types.
+
+### Modified
+
+- The `Worker` trait and its methods are now async.
+- Updated dependencies.
+
 ## v0.3.0 - 2021-02-16
 ### Added
 

implementations/rust/ockam/ockam_core/CHANGELOG.md

@@ -1,6 +1,6 @@
 [package]
 name = "ockam_core"
-version = "0.3.0"
+version = "0.4.0"
 authors = ["Ockam Developers"]
 edition = "2018"
 license = "Apache-2.0"

implementations/rust/ockam/ockam_core/Cargo.lock

@@ -21,7 +21,7 @@ Add this to your `Cargo.toml`:
 
 ```
 [dependencies]
-ockam_core = "0.3.0"
+ockam_core = "0.4.0"
 ```
 
 ## Crate Features
@@ -32,7 +32,7 @@ disabled as follows
 
 ```
 [dependencies]
-ockam_core = { version = "0.3.0", default-features = false }
+ockam_core = { version = "0.4.0", default-features = false }
 ```
 
 Please note that Cargo features are unioned across the entire dependency

implementations/rust/ockam/ockam_core/Cargo.toml

@@ -5,6 +5,7 @@ use crate::lib::{
 use core::ops::Deref;
 use serde::{Deserialize, Serialize};
 
+/// An external identifier for message routing.
 #[derive(Debug, Clone, Hash, Ord, PartialOrd, Eq, PartialEq, Serialize, Deserialize)]
 pub struct Address(Vec<u8>);
 

implementations/rust/ockam/ockam_core/README.md

@@ -7,7 +7,7 @@
 //! The main Ockam crate re-exports types defined in this crate.
 #![no_std]
 #![deny(
-    // missing_docs,
+    missing_docs,
     trivial_casts,
     trivial_numeric_casts,
     unsafe_code,

implementations/rust/ockam/ockam_core/src/address.rs

@@ -2,15 +2,17 @@ use crate::lib::Vec;
 use crate::Result;
 use serde::{de::DeserializeOwned, Serialize};
 
-// TODO: swap this for a non-heaped data structure
+/// Alias of the type used for encoded data.
 pub type Encoded = Vec<u8>;
 
 /// A user defined message that can be serialised and deserialised
 pub trait Message: Serialize + DeserializeOwned + Send + 'static {
+    /// Encode the type representation into an [`Encoded`] type.
     fn encode(&self) -> Result<Encoded> {
         Ok(bincode::serialize(self)?)
     }
 
+    /// Decode an [`Encoded`] type into the Message's type.
     #[allow(clippy::ptr_arg)]
     fn decode(e: &Encoded) -> Result<Self> {
         Ok(bincode::deserialize(e)?)

implementations/rust/ockam/ockam_core/src/lib.rs

@@ -4,7 +4,10 @@ use async_trait::async_trait;
 /// Base ockam worker trait.
 #[async_trait]
 pub trait Worker: Send + 'static {
+    /// The type of Message the Worker is sent in [`Self::handle_message`]
     type Message: Message;
+
+    /// The API and other resources available for the worker during message processing.
     type Context: Send + 'static;
 
     /// Override initialisation behaviour