YDotNet.Extensions
0.2.11
See the version list below for details.
dotnet add package YDotNet.Extensions --version 0.2.11
NuGet\Install-Package YDotNet.Extensions -Version 0.2.11
<PackageReference Include="YDotNet.Extensions" Version="0.2.11" />
paket add YDotNet.Extensions --version 0.2.11
#r "nuget: YDotNet.Extensions, 0.2.11"
// Install YDotNet.Extensions as a Cake Addin #addin nuget:?package=YDotNet.Extensions&version=0.2.11 // Install YDotNet.Extensions as a Cake Tool #tool nuget:?package=YDotNet.Extensions&version=0.2.11
YDotNet
YDotNet is a .NET binding for y-crdt
. It provides distributed data types that enable
real-time collaboration between devices. The library is a thin wrapper around Yrs, taking advantage of the safety and performance of Rust.
💡 Disclaimer: this project is still early, so it may contain bugs and the API is subject to change. Feel free to open an issue if you'd like to report problems or suggest new features.
Installation
This section is a WIP, the project has not yet been published to NuGet.
Getting Started
YDotNet provides the same shared data types as Yjs. All objects are shared within a
Doc
and always get modified within
the scope of a Transaction
.
// Set up the local document with some sample data.
var localDoc = new Doc();
var localText = localDoc.Text("name");
var localTransaction = localDoc.WriteTransaction();
localText.Insert(localTransaction, 0, "Y-CRDT");
localTransaction.Commit();
// Set up the remote document.
var remoteDoc = new Doc();
var remoteText = remoteDoc.Text("name");
// Get the remote document state vector.
var remoteTransaction = remoteDoc.WriteTransaction();
var remoteState = remoteTransaction.StateVectorV1();
// Calculate the state diff between the local and the remote document.
localTransaction = localDoc.ReadTransaction();
var stateDiff = localTransaction.StateDiffV1(remoteState);
localTransaction.Commit();
// Apply the state diff to synchronize the remote document with the local changes.
var result = remoteTransaction.ApplyV1(stateDiff);
// Read the text from the remote document.
var text = remoteText.String(remoteTransaction);
// At this point, the `text` variable is "Y-CRDT" and this demonstrates how the two
// documents synchronized their state.
//
// This example does it locally but the same could be done over the Internet, for example.
Development Setup
This section is a WIP, but you should be able to run the project through the unit tests after building a dynamic library for your operating system by adding
cdylib
to thecrate-type
in theCargo.toml
file of the yffi` library.
Tests
All tests are located in the YDotNet.Tests.Unit
project and should be easily runnable using the command:
dotnet test
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net7.0
- YDotNet (>= 0.2.11)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on YDotNet.Extensions:
Repository | Stars |
---|---|
Squidex/squidex
Headless CMS and Content Managment Hub
|