docs and pub

Signed-off-by: Adam Gutglick <adam@spiraldb.com>

Author: AdamGS

vortex-io/public-api.lock

@@ -380,6 +380,8 @@ pub fn vortex_io::runtime::Handle::spawn_blocking<F, R>(&self, F) -> vortex_io::
 
 pub fn vortex_io::runtime::Handle::spawn_cpu<F, R>(&self, F) -> vortex_io::runtime::Task<R> where F: core::ops::function::FnOnce() -> R + core::marker::Send + 'static, R: core::marker::Send + 'static
 
+pub fn vortex_io::runtime::Handle::spawn_io<Fut, R>(&self, Fut) -> vortex_io::runtime::Task<R> where Fut: core::future::future::Future<Output = R> + core::marker::Send + 'static, R: core::marker::Send + 'static
+
 pub fn vortex_io::runtime::Handle::spawn_nested<F, Fut, R>(&self, F) -> vortex_io::runtime::Task<R> where F: core::ops::function::FnOnce(vortex_io::runtime::Handle) -> Fut, Fut: core::future::future::Future<Output = R> + core::marker::Send + 'static, R: core::marker::Send + 'static
 
 impl core::clone::Clone for vortex_io::runtime::Handle

vortex-io/src/runtime/handle.rs

@@ -92,7 +92,11 @@ impl Handle {
     }
 
     /// Spawn a new I/O future onto the runtime.
-    pub(crate) fn spawn_io<Fut, R>(&self, f: Fut) -> Task<R>
+    ///
+    /// See [`Executor::spawn_io`] for more details about how this future is expected to run.
+    ///
+    // See [`Task`] for details on cancelling or detaching the spawned task.
+    pub fn spawn_io<Fut, R>(&self, f: Fut) -> Task<R>
     where
         Fut: Future<Output = R> + Send + 'static,
         R: Send + 'static,