Struct SymbolInformation

pub struct SymbolInformation {
    pub symbol: String,
    pub documentation: Vec<String>,
    pub relationships: Vec<Relationship>,
    pub kind: EnumOrUnknown<Kind>,
    pub display_name: String,
    pub signature_documentation: MessageField<Document>,
    pub enclosing_symbol: String,
    pub special_fields: SpecialFields,
}

SymbolInformation defines metadata about a symbol, such as the symbol’s docstring or what package it’s defined it.

Fields

symbol: String

Identifier of this symbol, which can be referenced from Occurence.symbol. The string must be formatted according to the grammar in Symbol.

documentation: Vec<String>

(optional, but strongly recommended) The markdown-formatted documentation for this symbol. Use SymbolInformation.signature_documentation to document the method/class/type signature of this symbol. Due to historical reasons, indexers may include signature documentation in this field by rendering markdown code blocks. New indexers should only include non-code documentation in this field, for example docstrings.

relationships: Vec<Relationship>

(optional) Relationships to other symbols (e.g., implements, type definition).

kind: EnumOrUnknown<Kind>

The kind of this symbol. Use this field instead of SymbolDescriptor.Suffix to determine whether something is, for example, a class or a method.

display_name: String

(optional) The name of this symbol as it should be displayed to the user. For example, the symbol “com/example/MyClass#myMethod(+1).” should have the display name “myMethod”. The symbol field is not a reliable source of the display name for several reasons:

• Local symbols don’t encode the name.
• Some languages have case-insensitive names, so the symbol is all-lowercase.
• The symbol may encode names with special characters that should not be displayed to the user.

signature_documentation: MessageField<Document>

(optional) The signature of this symbol as it’s displayed in API documentation or in hover tooltips. For example, a Java method that adds two numbers this would have Document.language = "java" and Document.text = "void add(int a, int b)". The languageandtextfields are required while other fields such asDocumentation.occurrences` can be optionally included to support hyperlinking referenced symbols in the signature.

enclosing_symbol: String

(optional) The enclosing symbol if this is a local symbol. For non-local symbols, the enclosing symbol should be parsed from the symbol field using the Descriptor grammar.

The primary use-case for this field is to allow local symbol to be displayed in a symbol hierarchy for API documentation. It’s OK to leave this field empty for local variables since local variables usually don’t belong in API documentation. However, in the situation that you wish to include a local symbol in the hierarchy, then you can use enclosing_symbol to locate the “parent” or “owner” of this local symbol. For example, a Java indexer may choose to use local symbols for private class fields while providing an enclosing_symbol to reference the enclosing class to allow the field to be part of the class documentation hierarchy. From the perspective of an author of an indexer, the decision to use a local symbol or global symbol should exclusively be determined whether the local symbol is accessible outside the document, not by the capability to find the enclosing symbol.

special_fields: SpecialFields

Implementations

impl SymbolInformation

pub fn new() -> SymbolInformation

Trait Implementations

impl Clone for SymbolInformation

fn clone(&self) -> SymbolInformation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolInformation

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

Formats the value using the given formatter.

impl<'a> Default for &'a SymbolInformation

fn default() -> &'a SymbolInformation

Returns the “default value” for a type.

impl Default for SymbolInformation

fn default() -> SymbolInformation

Returns the “default value” for a type.

impl Display for SymbolInformation

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

Formats the value using the given formatter.

impl Message for SymbolInformation

const NAME: &'static str = "SymbolInformation"

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() -> SymbolInformation

Create an empty message object.

fn clear(&mut self)

Reset all fields.

fn default_instance() -> &'static SymbolInformation

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 SymbolInformation

fn descriptor() -> MessageDescriptor

Get message descriptor for message type.

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

Reflective equality.

impl PartialEq for SymbolInformation

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

type RuntimeType = RuntimeTypeMessage<SymbolInformation>

Actual implementation of type properties.

impl StructuralPartialEq for SymbolInformation