Struct zksync_protobuf_build::ProtoName

pub struct ProtoName(/* private fields */);

In addition to input paths and proto paths, there are also proto names which are used to reference message types from different proto files. Theoretically proto names can be totally independent from the proto paths (i.e. you can have “my.favorite.package” proto package defined in “totally/unrelated/file/name.proto” file, but we recommend the following naming convention: proto package “a.b.c” should be defined either: a) in a single file “a/b/c.proto”, or b) in a collection of files under “a/b/c/” directory Option b) is useful for defining large packages, because there is no equivalent of “pub use” in proto syntax.

Implementations

impl ProtoName

pub fn starts_with(&self, prefix: &Self) -> bool

Checks if package path starts with the given prefix.

pub fn relative_to(&self, prefix: &Self) -> Result<Self>

Strips a given prefix from the name.

pub fn to_rust_module(&self) -> Result<RustName>

Converts proto package name to rust module name according to prost_build rules.

pub fn to_rust_type(&self) -> Result<RustName>

Converts proto message name to rust type name according to prost_build rules.

Trait Implementations

impl Clone for ProtoName

fn clone(&self) -> ProtoName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProtoName

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

Formats the value using the given formatter.

impl Display for ProtoName

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

Formats the value using the given formatter.

impl From<&Path> for ProtoName

fn from(p: &Path) -> Self

Converts to this type from the input type.

impl From<&str> for ProtoName

fn from(s: &str) -> Self

Converts to this type from the input type.

impl PartialEq for ProtoName

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for ProtoName

impl StructuralPartialEq for ProtoName