fix: doctests

This commit is contained in:
zaaarf 2024-10-10 12:25:06 +02:00 committed by alemi.dev
parent ce8dcc8b8c
commit 721d71dd18
3 changed files with 12 additions and 11 deletions

View file

@ -29,20 +29,21 @@ pub struct BufferUpdate {
/// new buffer, but smaller changes are efficient and easy to create or apply.
///
/// ### Examples
/// To insert 'a' after 4th character we should send a.
/// To insert 'a' after 4th character we should send:
/// ```
/// TextChange { start: 4, end: 4, content: "a".into(), hash: None }
/// codemp::api::TextChange { start: 4, end: 4, content: "a".into() };
/// ```
///
/// To delete a the fourth character we should send a.
/// To delete the fourth character we should send:
/// ```
/// TextChange { start: 3, end: 4, content: "".into(), hash: None }
/// codemp::api::TextChange { start: 3, end: 4, content: "".into() };
/// ```
///
/// ```
/// let change = codemp::api::TextChange {
/// start: 6, end: 11,
/// content: "mom".to_string(), hash: None
/// start: 6,
/// end: 11,
/// content: "mom".to_string()
/// };
/// let before = "hello world!";
/// let after = change.apply(before);

View file

@ -36,7 +36,7 @@ impl BufferController {
}
/// Notify CRDT that changes up to the given version have been merged succesfully.
pub fn ack(&mut self, version: Vec<i64>) {
pub fn ack(&self, version: Vec<i64>) {
let version = version.into_iter().map(|x| usize::from_ne_bytes(x.to_ne_bytes())).collect();
self.0.ack_tx
.send(version)

View file

@ -53,7 +53,7 @@
//! use codemp::api::controller::{AsyncSender, AsyncReceiver}; // needed to access trait methods
//! 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);
//! println!("user {} moved on buffer {}", event.user, event.sel.buffer);
//! # };
//! ```
//!
@ -69,12 +69,12 @@
//! # use codemp::api::controller::{AsyncSender, AsyncReceiver};
//! let buffer = workspace.attach("/some/file.txt").await.expect("failed to attach");
//! buffer.content(); // force-sync
//! if let Some(mut delta) = buffer.try_recv().await.unwrap() {
//! if let Some(mut update) = buffer.try_recv().await.unwrap() {
//! println!(
//! "content: {}, span: {}-{}",
//! delta.change.content, delta.change.start, delta.change.end
//! update.change.content, update.change.start, update.change.end
//! );
//! delta.ack();
//! buffer.ack(update.version);
//! } // if None, no changes are currently available
//! # };
//! ```