Struct Api

#[non_exhaustive]
pub struct Api {
    pub name: String,
    pub methods: Vec<Method>,
    pub options: Vec<Option>,
    pub version: String,
    pub source_context: Option<SourceContext>,
    pub mixins: Vec<Mixin>,
    pub syntax: Syntax,
}

Api is a light-weight descriptor for an API Interface.

Interfaces are also described as “protocol buffer services” in some contexts, such as by the “service” keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as “APIs” in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.

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.

name: String

The fully qualified name of this interface, including package name followed by the interface’s simple name.

methods: Vec<Method>

The methods of this interface, in unspecified order.

options: Vec<Option>

Any metadata attached to the interface.

version: String

A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here.

The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan.

The major version is also reflected in the package name of the interface, which must end in v<major-version>, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

source_context: Option<SourceContext>

Source context for the protocol buffer service represented by this message.

mixins: Vec<Mixin>

Included interfaces. See Mixin.

syntax: Syntax

The source syntax of the service.

Implementations

impl Api

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

Sets the value of name.

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

Sets the value of version.

pub fn set_source_context<T: Into<Option<SourceContext>>>(self, v: T) -> Self

Sets the value of source_context.

pub fn set_syntax<T: Into<Syntax>>(self, v: T) -> Self

Sets the value of syntax.

pub fn set_methods<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Method>,

Sets the value of methods.

pub fn set_options<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Option>,

Sets the value of options.

pub fn set_mixins<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Mixin>,

Sets the value of mixins.

Trait Implementations

impl Clone for Api

fn clone(&self) -> Api

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Api

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

Formats the value using the given formatter.

impl Default for Api

fn default() -> Api

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Api

where Api: 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 Api

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Api

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

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 Api