Expose host::api::Connector to users (risc0#864)

Since `ApiClient` has a method that requires a `Connector`, we need to make sure `Connector` is also public. This PR does that, and adds rudimentary docs for `Connector` (they're pretty minimal as I don't know any details about it). Co-authored-by: Frank Laub <[email protected]>
whoisgautxm · Sep 13, 2023 · 7663b8d · 7663b8d
1 parent e3ff7ff
commit 7663b8d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/risc0/zkvm/src/host/api/mod.rs b/risc0/zkvm/src/host/api/mod.rs
@@ -104,7 +104,9 @@ impl ConnectionWrapper {
     }
 }
 
+/// Connects a zkVM client and server
 pub trait Connector {
+    /// Create a client-server connection
     fn connect(&self) -> Result<ConnectionWrapper>;
 }
 

diff --git a/risc0/zkvm/src/lib.rs b/risc0/zkvm/src/lib.rs
@@ -47,6 +47,7 @@ pub use self::host::server::exec::profiler::Profiler;
 #[cfg(feature = "client")]
 pub use self::host::{
     api::client::Client as ApiClient,
+    api::Connector,
     client::{
         env::{ExecutorEnv, ExecutorEnvBuilder},
         exec::TraceEvent,