Struct Config

pub struct Config { /* private fields */ }

A config for configuring how tinc builds / generates code.

Implementations

impl Config

pub fn prost() -> Self

Available on crate feature prost only.

New config with prost mode.

pub fn new(mode: Mode) -> Self

Make a new config with a given mode.

pub fn new_with_out_dir(mode: Mode, out_dir: impl Into<PathBuf>) -> Self

Make a new config with a given mode.

pub fn disable_tinc_include(&mut self) -> &mut Self

Disable tinc auto-include. By default tinc will add its own annotations into the include path of protoc.

pub fn disable_root_module(&mut self) -> &mut Self

Disable the root module generation which allows for tinc::include_protos!() without providing a package.

pub fn btree_map(&mut self, path: impl Display) -> &mut Self

Specify a path to generate a BTreeMap instead of a HashMap for proto map.

pub fn bytes(&mut self, path: impl Display) -> &mut Self

Specify a path to generate bytes::Bytes instead of Vec<u8> for proto bytes.

pub fn boxed(&mut self, path: impl Display) -> &mut Self

Specify a path to wrap around a Box instead of including it directly into the struct.

pub fn float_with_non_finite_vals(&mut self, path: impl Display) -> &mut Self

Specify a path to float/double field (or derivative, like repeated float/double) that must use serializer/deserializer with non-finite values support (NaN/Infinity).

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

Compile and generate all the protos with the includes.

pub fn load_fds(&mut self, fds: impl Buf) -> Result<()>

Generate tinc code based on a precompiled FileDescriptorSet.

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.