Struct DocumentationRule 

#[non_exhaustive]
pub struct DocumentationRule {
    pub selector: String,
    pub description: String,
    pub deprecation_description: String,
    /* private fields */
}

A documentation rule provides information about individual API elements.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

selector: String

The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. 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 proto element (e.g. a message, a method, a ‘service’ definition, or a field). Defaults to leading & trailing comments taken from the proto source definition of the proto element.

deprecation_description: String

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

Implementations

impl DocumentationRule

pub fn new() -> Self

pub fn set_selector<T: Into<String>>(self, v: T) -> Self

Sets the value of selector.

pub fn set_description<T: Into<String>>(self, v: T) -> Self

Sets the value of description.

pub fn set_deprecation_description<T: Into<String>>(self, v: T) -> Self

Sets the value of deprecation_description.

Trait Implementations

impl Clone for DocumentationRule

fn clone(&self) -> DocumentationRule

Returns a duplicate of the value.

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 typename() -> &'static str

The typename of this message.

impl PartialEq for DocumentationRule

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