From 59aaf8f3b6f8ca35364783a3c096f48988024910 Mon Sep 17 00:00:00 2001 From: alemi Date: Sun, 10 Sep 2023 03:43:46 +0200 Subject: [PATCH] docs: fix references --- src/instance.rs | 32 ++++++++++++++++---------------- src/lib.rs | 12 ++++++------ 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/src/instance.rs b/src/instance.rs index aaf8bd6..3582b22 100644 --- a/src/instance.rs +++ b/src/instance.rs @@ -45,13 +45,13 @@ pub mod a_sync { } impl Instance { - /// connect to remote address instantiating a new client [crate::Client::new] + /// connect to remote address instantiating a new client [crate::client::Client::new] pub async fn connect(&self, addr: &str) -> Result<(), Error> { *self.client.lock().await = Some(Client::new(addr).await?); Ok(()) } - /// threadsafe version of [crate::Client::join] + /// threadsafe version of [crate::client::Client::join] pub async fn join(&self, session: &str) -> Result, Error> { self.client .lock().await @@ -61,7 +61,7 @@ pub mod a_sync { .await } - /// threadsafe version of [crate::Client::create] + /// threadsafe version of [crate::client::Client::create] pub async fn create(&self, path: &str, content: Option<&str>) -> Result<(), Error> { self.client .lock().await @@ -71,7 +71,7 @@ pub mod a_sync { .await } - /// threadsafe version of [crate::Client::attach] + /// threadsafe version of [crate::client::Client::attach] pub async fn attach(&self, path: &str) -> Result, Error> { self.client .lock().await @@ -81,7 +81,7 @@ pub mod a_sync { .await } - /// threadsafe version of [crate::Client::get_cursor] + /// threadsafe version of [crate::client::Client::get_cursor] pub async fn get_cursor(&self) -> Result, Error> { self.client .lock().await @@ -91,7 +91,7 @@ pub mod a_sync { .ok_or(Error::InvalidState { msg: "join workspace first".into() }) } - /// threadsafe version of [crate::Client::get_buffer] + /// threadsafe version of [crate::client::Client::get_buffer] pub async fn get_buffer(&self, path: &str) -> Result, Error> { self.client .lock().await @@ -101,7 +101,7 @@ pub mod a_sync { .ok_or(Error::InvalidState { msg: "join workspace first".into() }) } - /// threadsafe version of [crate::Client::leave_workspace] + /// threadsafe version of [crate::client::Client::leave_workspace] pub async fn leave_workspace(&self) -> Result<(), Error> { self.client .lock().await @@ -111,7 +111,7 @@ pub mod a_sync { Ok(()) } - /// threadsafe version of [crate::Client::disconnect_buffer] + /// threadsafe version of [crate::client::Client::disconnect_buffer] pub async fn disconnect_buffer(&self, path: &str) -> Result { let res = self.client .lock().await @@ -168,43 +168,43 @@ pub mod sync { /// return a reference to contained tokio runtime, to spawn tasks on pub fn rt(&self) -> &Handle { &self.runtime.handle() } - /// connect and store a client session, threadsafe and sync version of [crate::Client::new] + /// connect and store a client session, threadsafe and sync version of [crate::client::Client::new] pub fn connect(&self, addr: &str) -> Result<(), Error> { *self.client.lock().expect("client mutex poisoned") = Some(self.rt().block_on(Client::new(addr))?); Ok(()) } - /// threadsafe and sync version of [crate::Client::join] + /// threadsafe and sync version of [crate::client::Client::join] pub fn join(&self, session: &str) -> Result, Error> { self.if_client(|c| self.rt().block_on(c.join(session)))? } - /// threadsafe and sync version of [crate::Client::create] + /// threadsafe and sync version of [crate::client::Client::create] pub fn create(&self, path: &str, content: Option<&str>) -> Result<(), Error> { self.if_client(|c| self.rt().block_on(c.create(path, content)))? } - /// threadsafe and sync version of [crate::Client::attach] + /// threadsafe and sync version of [crate::client::Client::attach] pub fn attach(&self, path: &str) -> Result, Error> { self.if_client(|c| self.rt().block_on(c.attach(path)))? } - /// threadsafe and sync version of [crate::Client::get_cursor] + /// threadsafe and sync version of [crate::client::Client::get_cursor] pub fn get_cursor(&self) -> Result, Error> { self.if_client(|c| c.get_cursor().ok_or(Error::InvalidState { msg: "join workspace first".into() }))? } - /// threadsafe and sync version of [crate::Client::get_buffer] + /// threadsafe and sync version of [crate::client::Client::get_buffer] pub fn get_buffer(&self, path: &str) -> Result, Error> { self.if_client(|c| c.get_buffer(path).ok_or(Error::InvalidState { msg: "join workspace or create requested buffer first".into() }))? } - /// threadsafe and sync version of [crate::Client::leave_workspace] + /// threadsafe and sync version of [crate::client::Client::leave_workspace] pub fn leave_workspace(&self) -> Result<(), Error> { self.if_client(|c| c.leave_workspace()) } - /// threadsafe and sync version of [crate::Client::disconnect_buffer] + /// threadsafe and sync version of [crate::client::Client::disconnect_buffer] pub fn disconnect_buffer(&self, path: &str) -> Result { self.if_client(|c| c.disconnect_buffer(path)) } diff --git a/src/lib.rs b/src/lib.rs index fe28ca9..977b03c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -6,13 +6,13 @@ //! //! ## structure //! The main entrypoint is the [Instance] object, that maintains a connection and can -//! be used to join workspaces or attach to buffers. It contains the underlying [Client] and +//! be used to join workspaces or attach to buffers. It contains the underlying [client::Client] and //! stores active controllers. //! -//! Some actions will return structs implementing the [Controller] trait. These can be polled -//! for new stream events ([Controller::poll]/[Controller::recv]), which will be returned in order. -//! Blocking and callback variants are also implemented. The [Controller] can also be used to send new -//! events to the server ([Controller::send]). +//! Some actions will return structs implementing the [api::Controller] trait. These can be polled +//! for new stream events ([api::Controller::poll]/[api::Controller::recv]), which will be returned in order. +//! Blocking and callback variants are also implemented. The [api::Controller] can also be used to send new +//! events to the server ([api::Controller::send]). //! //! Each operation on a buffer is represented as an [ot::OperationSeq]. //! A visualization about how OperationSeqs work is available @@ -29,7 +29,7 @@ //! * `sync` : wraps the [instance::a_sync::Instance] holder into a sync variant: [instance::sync::Instance] //! //! ## examples -//! while the [Client] itself is the core structure implementing all methods, plugins will mostly +//! while the [client::Client] itself is the core structure implementing all methods, plugins will mostly //! interact with [Instance] managers. //! //! ### async