Struct gapi_grpc::google::api::DocumentationRule

pub struct DocumentationRule {
    pub selector: String,
    pub description: String,
    pub deprecation_description: String,
}

A documentation rule provides information about individual API elements.

Fields

selector: String

The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in “”, indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. “foo.” is ok, but not “foo.b*” or “foo..bar”. A wildcard will match one or more components. To specify a default for all applicable elements, the whole pattern “” is used.

description: String

Description of the selected API(s).

deprecation_description: String

Deprecation description of the selected element(s). It can be provided if an element is marked as deprecated.

Trait Implementations

impl Clone for DocumentationRule

fn clone(&self) -> DocumentationRule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentationRule

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

Formats the value using the given formatter.

impl Default for DocumentationRule

fn default() -> DocumentationRule

Returns the “default value” for a type.

impl Message for DocumentationRule

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

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> 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.

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

Encodes the message to a buffer.

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

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

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

Decodes an instance of the message from a buffer.

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

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

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

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

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

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

impl PartialEq<DocumentationRule> for DocumentationRule

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

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

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

This method tests for !=.

impl StructuralPartialEq for DocumentationRule