mirror of
https://github.com/ankitects/anki.git
synced 2025-11-06 20:57:13 -05:00
553303fc12
* Automatically elide empty inputs and outputs to backend methods * Refactor service generation Despite the fact that the majority of our Protobuf service methods require an open collection, they were not accessible with just a Collection object. To access the methods (e.g. because we haven't gotten around to exposing the correct API in Collection yet), you had to wrap the collection in a Backend object, and pay a mutex-acquisition cost for each call, even if you have exclusive access to the object. This commit migrates the majority of service methods to the Collection, so they can now be used directly, and improves the ergonomics a bit at the same time. The approach taken: - The service generation now happens in rslib instead of anki_proto, which avoids the need for trait constraints and associated types. - Service methods are assumed to be collection-based by default. Instead of implementing the service on Backend, we now implement it on Collection, which means our methods no longer need to use self.with_col(...). - We automatically generate methods in Backend which use self.with_col() to delegate to the Collection method. - For methods that are only appropriate for the backend, we add a flag in the .proto file. The codegen uses this flag to write the method into a BackendFooService instead of FooService, which the backend implements. - The flag can also allows us to define separate implementations for collection and backend, so we can e.g. skip the collection mutex in the i18n service while also providing the service on a collection.
34 lines
1.3 KiB
Protocol Buffer
34 lines
1.3 KiB
Protocol Buffer
// Copyright: Ankitects Pty Ltd and contributors
|
|
// License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
|
|
|
|
syntax = "proto3";
|
|
|
|
package anki.codegen;
|
|
|
|
import "google/protobuf/descriptor.proto";
|
|
|
|
extend google.protobuf.MethodOptions {
|
|
RustMethods rust_methods = 50000;
|
|
}
|
|
|
|
message MethodOptions {
|
|
RustMethods rust_methods = 50000;
|
|
}
|
|
|
|
enum RustMethods {
|
|
/// Used for typical collection-based operations. We must implement the
|
|
// method on Collection. The same method is automatically implemented on
|
|
// Backend, which forwards to Collection.
|
|
RUST_METHODS_COLLECTION_AND_AUTO_BACKEND = 0;
|
|
/// Method only makes sense on the backend (eg one that closes and reopens
|
|
/// the collection). Backend method needs to be implemented.
|
|
RUST_METHODS_BACKEND_ONLY = 1;
|
|
/// Both the backend and collection need to implement the method; there
|
|
/// is no auto-delegation. Can be used to provide a method on both, but
|
|
/// skip the Collection mutex lock when a backend handle is available.
|
|
/// In practice we only do this for the i18n methods; for the occasional
|
|
/// method in other services that doesn't happen to need the collection,
|
|
/// we just delegate to the collection method for convenience, and to make
|
|
/// sure it's available even if the consumer is not using Backend.
|
|
RUST_METHODS_COLLECTION_AND_MANUAL_BACKEND = 2;
|
|
}
|