Struct Builder

pub struct Builder { /* private fields */ }

Configuration builder for prost-validate code generation.

Builder::new()
    .compile_protos(&["path/to/protobuf.proto"], &["path/to/include"])
    .unwrap();

Implementations

impl Builder

pub fn new() -> Self

Create a new builder with default parameters.

pub fn file_descriptor_set_path<P>(&mut self, path: P) -> &mut Self

where P: Into<PathBuf>,

Set the path where the encoded file descriptor set is created. By default, it is created at $OUT_DIR/file_descriptor_set.bin.

This overrides the path specified by prost_build::Config::file_descriptor_set_path.

pub fn configure( &mut self, config: &mut Config, protos: &[impl AsRef<Path>], includes: &[impl AsRef<Path>], ) -> Result<()>

Configure config to derive [prost_validate::Validator] for all messages included in protos. This method does not generate prost-validate compatible code, but config may be used later to compile protocol buffers independently of Builder. protos and includes should be the same when prost_build::Config::compile_protos is called on config.

let mut config = Config::new();

// Customize config here

Builder::new()
    .configure(&mut config, &["path/to/protobuf.proto"], &["path/to/include"])
    .expect("Failed to configure for reflection");

// Custom compilation process with `config`
config.compile_protos(&["path/to/protobuf.proto"], &["path/to/includes"])
    .expect("Failed to compile protocol buffers");

pub fn configure_with_file_descriptor_protos( &mut self, config: &mut Config, protos: &[FileDescriptorProto], ) -> Result<()>

pub fn compile_protos_with_config( &mut self, config: Config, protos: &[impl AsRef<Path>], includes: &[impl AsRef<Path>], ) -> Result<()>

Compile protocol buffers into Rust with given prost_build::Config.

pub fn compile_protos( &mut self, protos: &[impl AsRef<Path>], includes: &[impl AsRef<Path>], ) -> Result<()>

Compile protocol buffers into Rust.

pub fn annotate(&self, config: &mut Config, descriptor: &DescriptorPool)

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.