loro-ffi 1.10.3

FFI bindings for Loro
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

# Loro FFI

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Version](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fgithub.com%2Floro-dev%2Floro-ffi%2Fraw%2Frefs%2Fheads%2Fmain%2FCargo.toml&query=%24.package.version&label=version)](Cargo.toml)
[![Rust](https://img.shields.io/badge/rust-1.0+-orange.svg)](https://www.rust-lang.org)

Foreign Function Interface (FFI) bindings for [Loro](https://loro.dev), a high-performance CRDT library for building collaborative applications.

## Overview

Loro FFI provides cross-language bindings for the Loro CRDT library, enabling developers to use Loro's powerful collaborative editing capabilities in various programming languages. Built with [UniFFI](https://mozilla.github.io/uniffi-rs/), this library generates clean, idiomatic bindings for multiple target languages.

JSONPath tooling now includes `subscribe_jsonpath`, a lightweight notification hook that fires (with possible false positives) when changes might affect a query—ideal for debounced or throttled watchers.

## Supported Languages

- [loro-swift](https://github.com/loro-dev/loro-swift): **Swift** Binding for Loro
- [loro-py](https://github.com/loro-dev/loro-py): **Python** Binding (pyo3) for Loro
- [loro-react-native](https://github.com/loro-dev/loro-react-native): **React Native** Turbo Module Binding for Loro
- [loro-cs](https://github.com/sensslen/loro-cs): **C#** Binding for Loro (community)
- [loro-go](https://github.com/aholstenson/loro-go): **Go** Binding for Loro (community)

## CHANGE LOG

You can find the updates [here](./doc/CHANGELOG.md)

## Build Binding

Read the UniFFI [documentation](https://mozilla.github.io/uniffi-rs/) and modify the [uniffi.toml](./uniffi.toml) configuration in this repository as needed.

Add this repository as a git submodule for your bindings:

```bash
git submodule add https://github.com/loro-dev/loro-ffi.git loro-ffi
git add .gitmodules loro-ffi
```

Build language-specific wrapper layers around the current UniFFI binding results to provide a better developer experience, including but not limited to:

- **Callback Function Wrapping**: Provide direct closure support for functions that require callback parameters, such as `LoroDoc::subscribe()`, `UndoManager::set_on_push()`, and `EphemeralStore::subscribe()`.

- **Native Type Extensions**: Implement `LoroValueLike` `ContainerIdLike` extensions for built-in types in target languages, enabling direct parameter usage:
  ```ts
  LoroMap.insert("key", "value");
  LoroMap.insert("key", 123);
  LoroMap.insert("key", true);
  LoroMap.insert("key", [1, 2, 3]);
  // ... and more
  ```

- **Unified Export Interface**: Create a unified entry point for `LoroDoc::export`:
  ```ts
  class LoroDoc {
    function export(mode: ExportMode) {
        // Wraps:
        // exportSnapshot()
        // exportUpdates(from)
        // exportUpdatesInRange(spans)
        // exportShallowSnapshot(frontiers)
        // exportStateOnly(frontiers)
        // exportSnapshotAt(frontiers)
    }
  }
  ```

- **Unified Container Creation Interface**: Provide unified entry points for creating child containers in `LoroMap`/`LoroList`/`LoroMovableList`:
  ```ts
  class LoroMap {
    function insertContainer(key: string, child: Container) {
        // Wraps:
        // insertListContainer
        // insertMapContainer
        // insertTextContainer
        // insertTreeContainer
        // insertMovableListContainer
        // insertCounterContainer
    }
    function getOrCreateContainer() {}
    // ... and more
  }
  ```

- **Standard Language Interfaces**: Implement essential interfaces (equality, comparison, ordering, etc.) for necessary data types as required by target programming languages.

- **Additional Enhancements**: And many other improvements to enhance usability and developer experience.

## Community

- **Discord**: [Join our Discord server](https://discord.gg/tUsBSVfqzf)
- **Twitter**: [@loro_dev](https://twitter.com/loro_dev)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.