Struct VisibilityRule

#[non_exhaustive]
pub struct VisibilityRule {
    pub selector: String,
    pub restriction: String,
}

A visibility rule provides visibility configuration for an individual API element.

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

Selects methods, messages, fields, enums, etc. to which this rule applies.

Refer to selector for syntax details.

restriction: String

A comma-separated list of visibility labels that apply to the selector. Any of the listed labels can be used to grant the visibility.

If a rule has multiple labels, removing one of the labels but not all of them can break clients.

Example:

visibility:
  rules:
  - selector: google.calendar.Calendar.EnhancedSearch
    restriction: INTERNAL, PREVIEW

Removing INTERNAL from this restriction will break clients that rely on this method and only had access to it through INTERNAL.

Implementations

impl VisibilityRule

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

Sets the value of selector.

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

Sets the value of restriction.

Trait Implementations

impl Clone for VisibilityRule

fn clone(&self) -> VisibilityRule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VisibilityRule

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

Formats the value using the given formatter.

impl Default for VisibilityRule

fn default() -> VisibilityRule

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VisibilityRule

where VisibilityRule: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for VisibilityRule

fn typename() -> &'static str

The typename of this message.

impl PartialEq for VisibilityRule

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for VisibilityRule