Struct Package 

#[non_exhaustive]
pub struct Package {
    pub name: FixedStr,
    pub files: Vec<ProtoFile>,
}

A struct representing a protobuf package.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: FixedStr

files: Vec<ProtoFile>

Implementations

impl Package

pub fn extern_paths(&self) -> Vec<(String, String)>

This method returns a list of tuples where the first element is the fully qualified name of the protobuf element (enum or message), and the second is its rust path.

It is meant to be used when setting up [tonic_prost_build]. For more information, visit the usage with tonic section.

Example

use protify::*;

use tonic_prost_build::Config;

// This would be defined in a separate crate
proto_package!(MY_PKG, name = "my_pkg");

// In the `build.rs` file of the consuming crate
let mut config = Config::new();

// Now all the items in this package will be imported directly from their
// crate of origin, and not generated from their protos
for (name, path) in MY_PKG::get_package().extern_paths() {
  config.extern_path(name, path);
}

pub fn render_files<P>(&self, output_root: P) -> Result<()>

where P: AsRef<Path>,

Available on crate feature std only.

Renders the files that belong to this Package, starting from the output root given as the only argument.

pub fn check_unique_cel_rules(self) -> Result<(), String>

Available on crate feature cel only.

Verifies that this package doesn’t contain CEL rules with the same ID in the scope of the same message.

Trait Implementations

impl Debug for Package

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Package

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Package

fn eq(&self, other: &Package) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Package

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Package