From d31b3d244a87e0d19906d4afa24ecdf59867b442 Mon Sep 17 00:00:00 2001 From: alemi Date: Wed, 25 Sep 2024 16:54:54 +0200 Subject: [PATCH] fix: use async blocks rather than main + async fn --- src/lib.rs | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index fa1abf5..c60ac2f 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -19,8 +19,7 @@ //! a supported remote server and returns a [`Client`] handle to interact with it. //! //! ```no_run -//! # fn main() {} -//! # async fn main_fn() { +//! # async { //! let client = codemp::Client::connect( //! codemp::api::Config::new( //! "mail@example.net", @@ -29,27 +28,25 @@ //! ) //! .await //! .expect("failed to connect!"); -//! # } +//! # }; //! ``` //! //! A [`Client`] can acquire a [`Workspace`] handle by joining an existing one it can access with //! [`Client::join_workspace`] or create a new one with [`Client::create_workspace`]. //! //! ```no_run -//! # fn main() {} -//! # async fn main_fn() { +//! # async { //! # let client = codemp::Client::connect(codemp::api::Config::new("", "")).await.unwrap(); //! client.create_workspace("my-workspace").await.expect("failed to create workspace!"); //! let workspace = client.join_workspace("my-workspace").await.expect("failed to attach!"); -//! # } +//! # }; //! ``` //! //! A [`Workspace`] handle can be used to acquire a [`cursor::Controller`] to track remote [`api::Cursor`]s //! and one or more [`buffer::Controller`] to send and receive [`api::TextChange`]s. //! //! ```no_run -//! # fn main() {} -//! # async fn main_fn() { +//! # async { //! # let client = codemp::Client::connect(codemp::api::Config::new("", "")).await.unwrap(); //! # client.create_workspace("").await.unwrap(); //! # let workspace = client.join_workspace("").await.unwrap(); @@ -57,7 +54,7 @@ //! let cursor = workspace.cursor(); //! let event = cursor.recv().await.expect("disconnected while waiting for event!"); //! println!("user {} moved on buffer {}", event.user.unwrap_or_default(), event.buffer); -//! # } +//! # }; //! ``` //! //! Internally, [`buffer::Controller`]s store the buffer state as a [diamond_types] CRDT, guaranteeing @@ -65,8 +62,7 @@ //! guaranteed to converge. //! //! ```no_run -//! # fn main() {} -//! # async fn main_fn() { +//! # async { //! # let client = codemp::Client::connect(codemp::api::Config::new("", "")).await.unwrap(); //! # client.create_workspace("").await.unwrap(); //! # let workspace = client.join_workspace("").await.unwrap(); @@ -76,7 +72,7 @@ //! if let Some(change) = buffer.try_recv().await.unwrap() { //! println!("content: {}, span: {}-{}", change.content, change.start, change.end); //! } // if None, no changes are currently available -//! # } +//! # }; //! ``` //! //! ## FFI