Merge pull request #649 from swimos/docs5

Tidy up of crate/module API: Stage 5

Author: horned-sphere

Cargo.toml

@@ -7,7 +7,6 @@ members = [
     "api/formats/swimos_*",
     "macro_utilities",
     "runtime/swimos_*",
-    "swimos_store",
     "swimos_utilities",
     "swimos_utilities/swimos_*",
     "swimos_downlink",

api/swimos_api/src/error/mod.rs

@@ -83,11 +83,8 @@ pub enum DownlinkFailureReason {
     UnresolvableLocal(RelativeAddress<Text>),
     #[error("Connection to the remote host failed: {0}")]
     ConnectionFailed(Arc<std::io::Error>),
-    #[error("Failed to negotiate a TLS connection: {error}")]
-    TlsConnectionFailed {
-        error: Arc<dyn std::error::Error + Send + Sync>,
-        recoverable: bool,
-    },
+    #[error("Failed to negotiate a TLS connection: {message}")]
+    TlsConnectionFailed { message: String, recoverable: bool },
     #[error("Could not negotiate a websocket connection: {0}")]
     WebsocketNegotiationFailed(String),
     #[error("The remote client stopped while the downlink was starting.")]

api/swimos_api/src/persistence.rs

@@ -153,3 +153,17 @@ impl PlanePersistence for StoreDisabled {
         ready(Ok(StoreDisabled)).boxed()
     }
 }
+
+pub trait ServerPersistence {
+    type PlaneStore: PlanePersistence + Clone + Send + Sync + 'static;
+
+    fn open_plane(&self, name: &str) -> Result<Self::PlaneStore, StoreError>;
+}
+
+impl ServerPersistence for StoreDisabled {
+    type PlaneStore = StoreDisabled;
+
+    fn open_plane(&self, _name: &str) -> Result<Self::PlaneStore, StoreError> {
+        Ok(Self)
+    }
+}

api/swimos_form/src/structural/mod.rs

@@ -36,7 +36,7 @@ use std::str::FromStr;
 /// use swimos_form::Form;
 /// use swimos_form::Tag;
 /// use swimos_model::{Attr, Item, Value};
-/// use swimos_model::time::Timestamp;
+/// use swimos_model::Timestamp;
 ///
 /// #[derive(Tag, Clone)]
 /// #

client/fixture/Cargo.toml

@@ -6,7 +6,7 @@ edition = "2021"
 [dependencies]
 swimos_runtime = { path = "../../runtime/swimos_runtime" }
 swimos_remote = { path = "../../runtime/swimos_remote" }
-swimos_net = { path = "../../runtime/swimos_net" }
+swimos_messages = { path = "../../runtime/swimos_messages" }
 swimos_api = { path = "../../api/swimos_api" }
 ratchet = { features = ["deflate", "split"], workspace = true }
 swimos_recon = { path = "../../api/formats/swimos_recon" }

client/fixture/src/lib.rs

@@ -14,16 +14,15 @@ use std::net::SocketAddr;
 use std::ops::DerefMut;
 use std::sync::Arc;
 use swimos_form::Form;
+use swimos_messages::remote_protocol::FindNode;
 use swimos_model::{Text, Value};
-use swimos_net::Scheme;
 use swimos_recon::parser::parse_recognize;
 use swimos_recon::print_recon;
-use swimos_remote::net::dns::{BoxDnsResolver, DnsResolver};
-use swimos_remote::net::{
-    ClientConnections, ConnResult, ConnectionError, IoResult, Listener, ListenerError,
+use swimos_remote::dns::{BoxDnsResolver, DnsResolver};
+use swimos_remote::websocket::{RatchetError, WebsocketClient, WebsocketServer, WsOpenFuture};
+use swimos_remote::{
+    ClientConnections, ConnectionError, ConnectionResult, Listener, ListenerError, Scheme,
 };
-use swimos_remote::ws::{RatchetError, WebsocketClient, WebsocketServer, WsOpenFuture};
-use swimos_remote::FindNode;
 use tokio::io::{AsyncRead, AsyncWrite, DuplexStream};
 use tokio::sync::mpsc;
 use tokio::sync::Mutex;
@@ -72,7 +71,7 @@ impl ClientConnections for MockClientConnections {
         _scheme: Scheme,
         _host: Option<&str>,
         addr: SocketAddr,
-    ) -> BoxFuture<'_, ConnResult<Self::ClientSocket>> {
+    ) -> BoxFuture<'_, ConnectionResult<Self::ClientSocket>> {
         async move {
             self.inner
                 .lock()
@@ -88,7 +87,11 @@ impl ClientConnections for MockClientConnections {
         Box::new(self.clone())
     }
 
-    fn lookup(&self, host: String, port: u16) -> BoxFuture<'static, IoResult<Vec<SocketAddr>>> {
+    fn lookup(
+        &self,
+        host: String,
+        port: u16,
+    ) -> BoxFuture<'static, std::io::Result<Vec<SocketAddr>>> {
         self.resolve(host, port).boxed()
     }
 }

client/runtime/Cargo.toml

@@ -19,7 +19,6 @@ swimos_form = { path = "../../api/swimos_form" }
 swimos_utilities = { path = "../../swimos_utilities", features = ["buf_channel", "trigger", "algebra"] }
 swimos_runtime = { path = "../../runtime/swimos_runtime" }
 swimos_remote = { path = "../../runtime/swimos_remote" }
-swimos_net = { path = "../../runtime/swimos_net" }
 swimos_messages = { path = "../../runtime/swimos_messages" }
 ratchet = { features = ["deflate", "split"], workspace = true }
 futures = { workspace = true }

client/runtime/src/commander/mod.rs

@@ -21,8 +21,8 @@ use ratchet::{
     CloseCode, CloseReason, NoExt, NoExtProvider, ProtocolRegistry, WebSocket, WebSocketConfig,
 };
 use swimos_form::write::StructuralWritable;
-use swimos_net::{BadUrl, SchemeHostPort};
 use swimos_recon::print_recon_compact;
+use swimos_remote::{BadWarpUrl, SchemeHostPort};
 use thiserror::Error;
 use tokio::net::TcpStream;
 
@@ -31,7 +31,7 @@ pub enum CommandError {
     #[error("Failed to send command: {0}")]
     Ratchet(#[from] ratchet::Error),
     #[error("Invalid URL: {0}")]
-    Url(#[from] BadUrl),
+    Url(#[from] BadWarpUrl),
 }
 
 impl From<std::io::Error> for CommandError {

client/runtime/src/models.rs

@@ -16,8 +16,8 @@ use fnv::FnvHashMap;
 use std::fmt::{Display, Formatter};
 use std::future::Future;
 use swimos_api::{address::RelativeAddress, agent::DownlinkKind};
+use swimos_messages::remote_protocol::AttachClient;
 use swimos_model::Text;
-use swimos_remote::AttachClient;
 use swimos_runtime::downlink::failure::{
     AlwaysAbortStrategy, AlwaysIgnoreStrategy, ReportStrategy,
 };

client/runtime/src/pending.rs

@@ -24,9 +24,9 @@ use std::pin::Pin;
 use std::task::{Context, Poll};
 use swimos_api::address::RelativeAddress;
 use swimos_client_api::DownlinkConfig;
+use swimos_messages::remote_protocol::AttachClient;
 use swimos_model::Text;
-use swimos_net::Scheme;
-use swimos_remote::AttachClient;
+use swimos_remote::Scheme;
 use swimos_runtime::downlink::{DownlinkOptions, DownlinkRuntimeConfig};
 use tokio::sync::mpsc;