Struct prost_types::SourceCodeInfo

pub struct SourceCodeInfo {
    pub location: Vec<Location>,
}

Encapsulates information about the original source file from which a FileDescriptorProto was generated.

Fields

location: Vec<Location>

A Location identifies a piece of source code in a .proto file which corresponds to a particular definition. This information is intended to be useful to IDEs, code indexers, documentation generators, and similar tools.

For example, say we have a file like: message Foo { optional string foo = 1; } Let's look at just the field definition: optional string foo = 1; ^ ^^ ^^ ^ ^^^ a bc de f ghi We have the following locations: span path represents [a,i) [ 4, 0, 2, 0 ] The whole field definition. [a,b) [ 4, 0, 2, 0, 4 ] The label (optional). [c,d) [ 4, 0, 2, 0, 5 ] The type (string). [e,f) [ 4, 0, 2, 0, 1 ] The name (foo). [g,h) [ 4, 0, 2, 0, 3 ] The number (1).

Notes:

• A location may refer to a repeated field itself (i.e. not to any particular index within it). This is used whenever a set of elements are logically enclosed in a single code segment. For example, an entire extend block (possibly containing multiple extension definitions) will have an outer location whose path refers to the "extensions" repeated field without an index.
• Multiple locations may have the same path. This happens when a single logical declaration is spread out across multiple places. The most obvious example is the "extend" block again -- there may be multiple extend blocks in the same scope, each of which will have the same path.
• A location's span is not always a subset of its parent's span. For example, the "extendee" of an extension declaration appears at the beginning of the "extend" block and is shared by all extensions within the block.
• Just because a location's span is a subset of some other location's span does not mean that it is a descendent. For example, a "group" defines both a type and a field in a single declaration. Thus, the locations corresponding to the type and field and their components will overlap.
• Code which tries to interpret locations should probably be designed to ignore those that it doesn't understand, as more types of locations could be recorded in the future.

Trait Implementations

impl Message for SourceCodeInfo

fn encode_raw<B>(&self, buf: &mut B) where     B: BufMut,

fn merge_field<B>(&mut self, buf: &mut B) -> Result<(), DecodeError> where     B: Buf,

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where     B: BufMut,

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where     B: BufMut,

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where     B: IntoBuf,     Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where     B: IntoBuf,     Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where     B: IntoBuf,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where     B: IntoBuf,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Default for SourceCodeInfo

fn default() -> SourceCodeInfo

Returns the "default value" for a type.

impl Debug for SourceCodeInfo

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

Formats the value using the given formatter.

impl Clone for SourceCodeInfo

fn clone(&self) -> SourceCodeInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for SourceCodeInfo

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

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

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

This method tests for !=.