hexedtech/codemp
3
0
Fork 0
mirror of https://github.com/hexedtech/codemp.git synced 2024-12-23 05:14:54 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: mentioned Instance early on

Browse source
This commit is contained in:
əlemi 2023-09-05 01:31:57 +02:00
parent 4bf3c1c7a5
commit ed2f6688c3
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
src/lib.rs
View file

@ -5,8 +5,9 @@
//! This is the core library of the codemp project.
//!
//! ## structure
//! The main entrypoint is the [Client] object, that maintains a connection and can
//! be used to join workspaces or attach to buffers.
//! 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
//! 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.