Struct ProtoFile 

pub struct ProtoFile {
    pub source: String,
    pub package: String,
    pub schema_id: String,
    pub allow_list: Option<String>,
    pub document_format: String,
    pub messages: Vec<Message>,
    pub enums: Vec<Enum>,
}

One parsed .proto document schema.

Fields

source: String

Where it was read from, for diagnostics.

package: String

The package declaration.

schema_id: String

option (majordomus.schema_id), the identity that fixes this file’s path.

allow_list: Option<String>

option (majordomus.allow_list); absent means the kind projects no allow-list.

document_format: String

option (majordomus.document_format).

messages: Vec<Message>

Every message, in declaration order.

enums: Vec<Enum>

Every enum, in declaration order.

Implementations

impl ProtoFile

pub fn message(&self, name: &str) -> Option<&Message>

The message with this name.

pub fn enumeration(&self, name: &str) -> Option<&Enum>

The enum with this name.

pub fn header(&self) -> Result<&Message, Error>

The Header message, which every document schema must declare.

pub fn body(&self) -> Option<&Message>

The Body message, when the kind describes one.

pub fn expected_path(schema_id: &str) -> Result<String, Error>

The path this file’s identity fixes, relative to the schema root: majordomus.adr/v1 is majordomus/adr/adr.v1.proto. The identity and the path are checked against each other on load, so neither can drift from the other.

pub fn identity_of(relative: &str) -> Option<String>

The identity a path under the schema root carries, the inverse of Self::expected_path. A path that does not have the shape yields nothing.

Trait Implementations

impl Clone for ProtoFile

fn clone(&self) -> ProtoFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtoFile

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

Formats the value using the given formatter.

impl Eq for ProtoFile

impl PartialEq for ProtoFile

fn eq(&self, other: &ProtoFile) -> 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 StructuralPartialEq for ProtoFile