Struct Documentation 

pub struct Documentation {
    pub summary: String,
    pub pages: RepeatedField<Page>,
    pub rules: RepeatedField<DocumentationRule>,
    pub documentation_root_url: String,
    pub service_root_url: String,
    pub overview: String,
    pub unknown_fields: UnknownFields,
    pub cached_size: CachedSize,
}

Generated files are compatible only with the same version of protobuf runtime.

Fields

summary: String

pages: RepeatedField<Page>

rules: RepeatedField<DocumentationRule>

documentation_root_url: String

service_root_url: String

overview: String

unknown_fields: UnknownFields

cached_size: CachedSize

Implementations

impl Documentation

pub fn new() -> Documentation

pub fn get_summary(&self) -> &str

pub fn clear_summary(&mut self)

pub fn set_summary(&mut self, v: String)

pub fn mut_summary(&mut self) -> &mut String

pub fn take_summary(&mut self) -> String

pub fn get_pages(&self) -> &[Page]

pub fn clear_pages(&mut self)

pub fn set_pages(&mut self, v: RepeatedField<Page>)

pub fn mut_pages(&mut self) -> &mut RepeatedField<Page>

pub fn take_pages(&mut self) -> RepeatedField<Page>

pub fn get_rules(&self) -> &[DocumentationRule]

pub fn clear_rules(&mut self)

pub fn set_rules(&mut self, v: RepeatedField<DocumentationRule>)

pub fn mut_rules(&mut self) -> &mut RepeatedField<DocumentationRule>

pub fn take_rules(&mut self) -> RepeatedField<DocumentationRule>

pub fn get_documentation_root_url(&self) -> &str

pub fn clear_documentation_root_url(&mut self)

pub fn set_documentation_root_url(&mut self, v: String)

pub fn mut_documentation_root_url(&mut self) -> &mut String

pub fn take_documentation_root_url(&mut self) -> String

pub fn get_service_root_url(&self) -> &str

pub fn clear_service_root_url(&mut self)

pub fn set_service_root_url(&mut self, v: String)

pub fn mut_service_root_url(&mut self) -> &mut String

pub fn take_service_root_url(&mut self) -> String

pub fn get_overview(&self) -> &str

pub fn clear_overview(&mut self)

pub fn set_overview(&mut self, v: String)

pub fn mut_overview(&mut self) -> &mut String

pub fn take_overview(&mut self) -> String

Trait Implementations

impl Clear for Documentation

fn clear(&mut self)

Clear this make, make it equivalent to newly created object.

impl Clone for Documentation

fn clone(&self) -> Documentation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Documentation

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

Formats the value using the given formatter.

impl<'a> Default for &'a Documentation

fn default() -> &'a Documentation

Returns the “default value” for a type.

impl Default for Documentation

fn default() -> Documentation

Returns the “default value” for a type.

impl Message for Documentation

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<'_>) -> ProtobufResult<()>

Update this message object with fields read from given stream.

fn compute_size(&self) -> u32

Compute and cache size of this message and all nested messages

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

Write message to the stream.

fn get_cached_size(&self) -> u32

Get size previously computed by compute_size.

fn get_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.

fn as_any(&self) -> &dyn Any

View self as Any.

fn as_any_mut(&mut self) -> &mut dyn Any

View self as mutable Any.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Convert boxed self to boxed Any.

fn descriptor(&self) -> &'static MessageDescriptor

Message descriptor for this message, used for reflection.

fn new() -> Documentation

Create an empty message object.

fn descriptor_static() -> &'static MessageDescriptor

Get message descriptor for message type.

fn default_instance() -> &'static Documentation

Return a pointer to default immutable message with static lifetime.

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

where Self: Sized,

Parse message from stream.

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

Write the message to the stream.

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

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<(), ProtobufError>

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

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

Update this message object with fields read from given stream.

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

where Self: Sized,

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

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

where Self: Sized,

Parse message from byte array.

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

Check if all required fields of this object are initialized.

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

Write the message to the writer.

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

Write the message to bytes vec.

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

Write the message to bytes vec.

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

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>, ProtobufError>

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

fn type_id(&self) -> TypeId

Get type id for downcasting.

impl PartialEq for Documentation

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

fn as_ref(&self) -> ReflectValueRef<'_>

As ref

fn as_any(&self) -> &(dyn Any + 'static)

Convert to Any

fn is_non_zero(&self) -> bool

Is value non-zero?

fn as_ref_copy(&self) -> ReflectValueRef<'static>

Return ProtobufValueRef if self is Copy.

impl StructuralPartialEq for Documentation