Add documentation

Cargo.toml

@@ -8,6 +8,9 @@ description = "Pure rust nakama protocol implementation"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
+[features]
+test = []
+
 [dependencies]
 base64 = "0.13"
 nanoserde = "0.1.26"
@@ -18,7 +21,9 @@ log = "0.4.14"
 isahc = "1.4.0"
 qws = { version = "0.7.9", features = ["ssl"] }
 
+#[cfg(feature = "test")]
+futures = "0.3.15"
+
 [dev-dependencies]
 simple_logger = "1.11.0"
 cassette = "0.2.3"
-futures = "0.3.15"

examples/async.rs

@@ -77,7 +77,7 @@ fn main() {
         .unwrap();
 
     let http_adapter = RestHttpAdapter::new("http://127.0.0.1", 7350);
-    let client = DefaultClient::new(http_adapter);
+    let client = DefaultClient::new(http_adapter, "defaultkey", "");
     let adapter = WebSocketAdapter::new();
     let adapter2 = WebSocketAdapter::new();
     let web_socket = Arc::new(WebSocket::new(adapter));
@@ -116,10 +116,10 @@ fn main() {
             let session2 = client
                 .authenticate_device("testdeviceid2", None, true, HashMap::new())
                 .await;
-            let mut session = session.unwrap();
-            let mut session2 = session2.unwrap();
-            web_socket.connect(&mut session, true, -1).await;
-            web_socket2.connect(&mut session2, true, -1).await;
+            let session = session.unwrap();
+            let session2 = session2.unwrap();
+            web_socket.connect(&session, true, -1).await;
+            web_socket2.connect(&session2, true, -1).await;
         }
     };
 

examples/async_single_threaded.rs

@@ -51,7 +51,7 @@ fn main() {
         .unwrap();
 
     let http_adapter = RestHttpAdapter::new("http://127.0.0.1", 7350);
-    let client = DefaultClient::new(http_adapter);
+    let client = DefaultClient::new(http_adapter, "defaultkey", "");
     let adapter = WebSocketAdapter::new();
     let adapter2 = WebSocketAdapter::new();
     let web_socket = WebSocket::new(adapter);
@@ -72,10 +72,10 @@ fn main() {
                         let session2 = client
                             .authenticate_device("testdeviceid2", None, true, HashMap::new())
                             .await;
-                        let mut session = session.unwrap();
-                        let mut session2 = session2.unwrap();
-                        web_socket.connect(&mut session, true, -1).await;
-                        web_socket2.connect(&mut session2, true, -1).await;
+                        let session = session.unwrap();
+                        let session2 = session2.unwrap();
+                        web_socket.connect(&session, true, -1).await;
+                        web_socket2.connect(&session2, true, -1).await;
                         state.replace(Connected);
                     }
                     JoiningChat => {

examples/socket.rs

@@ -30,7 +30,7 @@ fn main() {
 
         let (tx_presence, rx_presence) = mpsc::channel::<StatusPresenceEvent>();
 
-        let mut session = client
+        let session = client
             .authenticate_device("socket_example_id", None, true, HashMap::new())
             .await
             .expect("Failed to authenticate");
@@ -41,7 +41,7 @@ fn main() {
                 .expect("Failed to send status presence");
         });
 
-        socket.connect(&mut session, true, -1).await;
+        socket.connect(&session, true, -1).await;
 
         let status_presence = rx_presence
             .recv()