Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial Eio port #284

Merged
merged 1 commit into from
Nov 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,21 @@
- Add `Capnp_rpc.Std` with some common module aliases, to reduce the need
to `open Capnp_rpc` (which is rather large).

- Convert API from Lwt to Eio.

To update to the new API:

1. Replace `open Capnp_rpc_lwt` with `open Capnp_rpc.Std`.
2. Replace all other uses of `Capnp_rpc_lwt` with just `Capnp_rpc`.
3. In `dune` and `opam` files, replace `capnp-rpc-lwt` with `capnp-rpc`.
4. Some modules are in `Capnp_rpc` but not the `Capnp_rpc.Std` subset.
1. Use [lwt_eio][] during the migration to allow using Eio and Lwt together in your application.
2. Replace `open Capnp_rpc_lwt` with `open Capnp_rpc.Std`.
3. Replace all other uses of `Capnp_rpc_lwt` with just `Capnp_rpc`.
4. In `dune` and `opam` files, replace `capnp-rpc-lwt` with `capnp-rpc`.
5. Some modules are in `Capnp_rpc` but not the `Capnp_rpc.Std` subset.
Those should now be fully qualified (e.g. replace `Persistence` with
`Capnp_rpc.Persistence`).
6. Replace `Service.return_lwt` with `Lwt_eio.run_lwt`.
7. Once all Lwt code is gone, `lwt_eio` can be removed.

[lwt_eio]: https://github.com/ocaml-multicore/lwt_eio

### v1.2.3

Expand Down
Loading
Loading