Crate zksync_protobuf

Code generated from protobuf schema files and utilities for serialization.

Re-exports

pub use repr::read_optional_repr;

pub use repr::read_required_repr;

pub use repr::ProtoRepr;

Modules

proto

repr

Trait for defining proto conversion for external types.

serde

Implementation of serde traits for structs implementing ProtoFmt. This serde implementation is compatible with protobuf json mapping, therefore it is suitable for version control. WARNING: Currently this serde implementation uses reflection, so it is not very efficient.

testonly

Testonly utilities.

Macros

declare_descriptor

Expands to a descriptor declaration.

impl_reflect_message

Implements ReflectMessage for a type based on a provided Descriptor.

impl_serde_deserialize

Implements serde::Deserialize compatible with protobuf json encoding.

impl_serde_serialize

Implements serde::Serialize compatible with protobuf json encoding.

Constants

MB

Megabyte.

kB

Kilobyte.

Traits

ProtoFmt

Trait defining a proto representation for a type.

Functions

canonical

Encodes a proto message of known schema (no unknown fields) into a canonical form.

canonical_raw

Converts an encoded protobuf message to its canonical form, given the descriptor of the message type. Returns an error if:

decode

Decodes a proto message.

encode

Encodes a proto message. Currently it outputs a canonical encoding, but decode accepts non-canonical encoding as well. It would simplify invariants if we required all messages to be canonical, but we will see whether it is feasible once we have an RPC framework in place.

read_map

Parses a repeated proto struct into a map.

read_optional

Parses an optional proto field.

read_required

Parses a required proto field.

required

Extracts a required field.