Модули Protobuf

Система сборки поддерживает создание интерфейсов protobuf через тип модуля rust_protobuf .

Базовая генерация кода protobuf выполняется с помощью rust-protobuf . Чтобы просмотреть документацию по этому использованию, см. страницу проекта GitHub с соответствующими примерами protobuf.

Также поддерживаются протобуферы gRPC, генерация которых обеспечивается grpc-rs . Чтобы просмотреть документацию по этому использованию, см. документацию на соответствующей странице проекта gRPC GitHub .

Базовое использование сборки rust_protobuf

Ниже приведен пример определения модуля protobuf и использования этого модуля в качестве контейнера. Более подробная информация о важных свойствах и их использовании находится в разделе « Определение rust_protobuf ».

Если вам нужно использовать сгенерированный protobuf код с помощью макроса include!() , например, для стороннего кода, см. пример на странице Генераторы исходного кода. (В примере используется модуль rust_bindgen , но средства включения исходного кода одинаковы для всех генераторов исходного кода.)

Определение модуля rust_protobuf Android.bp

Предположим, что какой-то прототип находится в src/protos/my.proto относительно вашего Android.bp; тогда модуль определяется следующим образом:

rust_protobuf {
    name: "libmy_proto",

    // Crate name that's used to generate the rust_library variants.
    crate_name: "my_proto",

    // Relative paths to the protobuf source files
    protos: ["src/protos/my.proto"],

    // If protobufs define gRPCs, then they should go in grpc_protos
    // instead.
    // grpc_protos: ["src/protos/my.proto"],


    // 'source_stem' controls the output filename.
    // This is the filename that's used in an include! macro.
    source_stem: "my_proto_source",
}

Библиотека, которая использует этот крейт, определяется ссылкой на него, как если бы это была любая другая зависимость библиотеки:

rust_binary {
    name: "hello_rust_proto",
    srcs: ["src/main.rs"],
    rustlibs: ["libmy_proto"],
}

Структура крейта модулей rust_protobuf

Каждый файл protobuf организован как отдельный модуль в крейте, получивший имя файла protobuf. Это означает, что все имена базовых файлов proto должны быть уникальными. Например, возьмем rust_protobuf , определенный следующим образом:

rust_protobuf {
    name: "libfoo",
    crate_name: "foo",
    protos: ["a.proto", "b.proto"],
    grpc_protos: ["c.proto"],
    source_stem: "my_proto_source",
}

Доступ к различным прототипам в этом ящике будет осуществляться следующим образом:

// use <crate_name>::<proto_filename>
use foo::a; // protobuf interface defined in a.proto
use foo::b; // protobuf interface defined in b.proto
use foo::c; // protobuf interface defined in c.proto
use foo::c_grpc; // grpc interface defined in c.proto

Известные свойства rust_protobuf

Определенные ниже свойства являются дополнением к важным общим свойствам , которые применяются ко всем модулям. Они либо особенно важны для модулей Rust protobuf, либо демонстрируют уникальное поведение, специфичное для типа модуля rust_protobuf .

ствол, имя, crate_name

rust_protobuf создает варианты библиотек, поэтому для этих трех свойств существуют те же требования, что и для модулей rust_library . Подробности смотрите в свойствах rust_library .

протос

Это список относительных путей к файлам protobuf для создания интерфейса protobuf. Базовые имена файлов должны быть уникальными для protos и grpc_protos .

grpc_protos

grpc_protos состоит из списка относительных путей к файлам protobuf, которые определяют grpcs для создания интерфейса protobuf. Базовые имена файлов должны быть уникальными для protos и grpc_protos .

source_stem

source_stem — это имя сгенерированного исходного файла , который можно включить. Это обязательное определение поля, даже если вы используете привязки в качестве ящика, поскольку свойство stem управляет только именем выходного файла для сгенерированных вариантов библиотеки. В отличие от других генераторов исходного кода, имя файла имеет префикс mod_ , что делает окончательное имя файла mod_<stem> . Это предотвращает конфликты имен с сгенерированными источниками из каждого прототипа.

Кроме того, как и в модуле привязок bindgen, полный набор свойств библиотеки также доступен для управления компиляцией библиотеки, хотя их редко нужно определять или изменять.