Struct Symbol

pub struct Symbol {
    pub scheme: String,
    pub package: MessageField<Package>,
    pub descriptors: Vec<Descriptor>,
    pub special_fields: SpecialFields,
}

Symbol is similar to a URI, it identifies a class, method, or a local variable. SymbolInformation contains rich metadata about symbols such as the docstring.

Symbol has a standardized string representation, which can be used interchangeably with Symbol. The syntax for Symbol is the following:

<symbol>               ::= <scheme> ' ' <package> ' ' (<descriptor>)+ | 'local ' <local-id>
<package>              ::= <manager> ' ' <package-name> ' ' <version>
<scheme>               ::= any UTF-8, escape spaces with double space. Must not be empty nor start with 'local'
<manager>              ::= any UTF-8, escape spaces with double space. Use the placeholder '.' to indicate an empty value
<package-name>         ::= same as above
<version>              ::= same as above
<descriptor>           ::= <namespace> | <type> | <term> | <method> | <type-parameter> | <parameter> | <meta> | <macro>
<namespace>            ::= <name> '/'
<type>                 ::= <name> '#'
<term>                 ::= <name> '.'
<meta>                 ::= <name> ':'
<macro>                ::= <name> '!'
<method>               ::= <name> '(' (<method-disambiguator>)? ').'
<type-parameter>       ::= '[' <name> ']'
<parameter>            ::= '(' <name> ')'
<name>                 ::= <identifier>
<method-disambiguator> ::= <simple-identifier>
<identifier>           ::= <simple-identifier> | <escaped-identifier>
<simple-identifier>    ::= (<identifier-character>)+
<identifier-character> ::= '_' | '+' | '-' | '$' | ASCII letter or digit
<escaped-identifier>   ::= '`' (<escaped-character>)+ '`', must contain at least one non-<identifier-character>
<escaped-characters>   ::= any UTF-8, escape backticks with double backtick.
<local-id>             ::= <simple-identifier>

The list of descriptors for a symbol should together form a fully qualified name for the symbol. That is, it should serve as a unique identifier across the package. Typically, it will include one descriptor for every node in the AST (along the ancestry path) between the root of the file and the node corresponding to the symbol.

Local symbols MUST only be used for entities which are local to a Document, and cannot be accessed from outside the Document.

Fields

scheme: String

package: MessageField<Package>

descriptors: Vec<Descriptor>

special_fields: SpecialFields

Implementations

impl Symbol

pub fn new() -> Symbol

impl Symbol

pub fn new_local(id: usize) -> Self

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl<'a> Default for &'a Symbol

fn default() -> &'a Symbol

Returns the “default value” for a type.

impl Default for Symbol

fn default() -> Symbol

Returns the “default value” for a type.

impl Display for Symbol

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

Formats the value using the given formatter.

impl Message for Symbol

const NAME: &'static str = "Symbol"

Message name as specified in .proto file.

fn is_initialized(&self) -> bool

True iff all required fields are initialized. Always returns true for protobuf 3.

fn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> Result<()>

Update this message object with fields read from given stream.

fn compute_size(&self) -> u64

Compute and cache size of this message and all nested messages.

fn write_to_with_cached_sizes( &self, os: &mut CodedOutputStream<'_>, ) -> Result<()>

Write message to the stream.

fn special_fields(&self) -> &SpecialFields

Special fields (unknown fields and cached size).

fn mut_special_fields(&mut self) -> &mut SpecialFields

Special fields (unknown fields and cached size).

fn new() -> Symbol

Create an empty message object.

fn clear(&mut self)

Reset all fields.

fn default_instance() -> &'static Symbol

Return a pointer to default immutable message with static lifetime.

fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self, Error>

Parse message from stream.

fn cached_size(&self) -> u32

Get size previously computed by compute_size.

fn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<(), Error>

Write the message to the stream.

fn write_length_delimited_to( &self, os: &mut CodedOutputStream<'_>, ) -> Result<(), Error>

Write the message to the stream prepending the message with message length encoded as varint.

fn write_length_delimited_to_vec(&self, vec: &mut Vec<u8>) -> Result<(), Error>

Write the message to the vec, prepend the message with message length encoded as varint.

fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<(), Error>

Update this message object with fields read from given stream.

fn parse_from_reader(reader: &mut dyn Read) -> Result<Self, Error>

Parse message from reader. Parse stops on EOF or when error encountered.

fn parse_from_bytes(bytes: &[u8]) -> Result<Self, Error>

Parse message from byte array.

fn check_initialized(&self) -> Result<(), Error>

Check if all required fields of this object are initialized.

fn write_to_writer(&self, w: &mut dyn Write) -> Result<(), Error>

Write the message to the writer.

fn write_to_vec(&self, v: &mut Vec<u8>) -> Result<(), Error>

Write the message to bytes vec.

fn write_to_bytes(&self) -> Result<Vec<u8>, Error>

Write the message to bytes vec.

fn write_length_delimited_to_writer( &self, w: &mut dyn Write, ) -> Result<(), Error>

Write the message to the writer, prepend the message with message length encoded as varint.

fn write_length_delimited_to_bytes(&self) -> Result<Vec<u8>, Error>

Write the message to the bytes vec, prepend the message with message length encoded as varint.

fn unknown_fields(&self) -> &UnknownFields

Get a reference to unknown fields.

fn mut_unknown_fields(&mut self) -> &mut UnknownFields

Get a mutable reference to unknown fields.

impl MessageFull for Symbol

fn descriptor() -> MessageDescriptor

Get message descriptor for message type.

fn reflect_eq(&self, other: &Self, mode: &ReflectEqMode) -> bool

Reflective equality.

impl PartialEq for Symbol

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

type RuntimeType = RuntimeTypeMessage<Symbol>

Actual implementation of type properties.

impl StructuralPartialEq for Symbol