Struct pb_jelly_gen::GenProtos

pub struct GenProtos { /* fields omitted */ }

A builder struct to configure the way your protos are generated, create one with GenProtos::builder()

Implementations

impl GenProtos

pub fn builder() -> GenProtos

Create a default builder

pub fn out_path<P: AsRef<Path>>(self, path: P) -> GenProtos

Set the output path for the generated code. This should be relative to the current crate’s manifest.

Defaults to the <current crate's manifest>/gen

pub fn abs_out_path<P: AsRef<Path>>(self, path: P) -> GenProtos

Set the output path for the generate code. This will be treated as an absolute path.

pub fn src_path<P: AsRef<Path>>(self, path: P) -> GenProtos

Add a path to a .proto file, or a directory containing your proto files.

pub fn src_paths<P: AsRef<Path>, I: IntoIterator<Item = P>>(
    self,
    paths: I
) -> GenProtos

Add a list of paths to .proto files, or to directories containing your proto files.

pub fn include_path<P: AsRef<Path>>(self, path: P) -> GenProtos

A path to a protobuf file, or a directory containing protobuf files, that get included in the proto compilation. Rust bindings will not be generated for these files, but the proto compiler will look at included paths for proto dependencies.

pub fn include_paths<P: AsRef<Path>, I: IntoIterator<Item = P>>(
    self,
    paths: I
) -> GenProtos

Paths to a protobuf files, or directories containing protobuf files, that get included in the proto compilation. Rust bindings will not be generated for these files, but the proto compiler will look at included paths for proto dependencies.

pub fn include_extensions(self, include: bool) -> GenProtos

Include rust/extensions.proto in the proto compilation.

Defaults to true

pub fn cleanup_out_path(self, cleanup: bool) -> GenProtos

If true, before proto compilation, will delete whatever exists at out_path and create a directory at that location.

pub fn gen_protos(self)

Consumes the builder and generates Rust bindings to your proto files.

Trait Implementations

impl Default for GenProtos

fn default() -> Self

Returns the “default value” for a type.