Struct prost_types::Api

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: i32,
}

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

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: i32

The source syntax of the service.

Implementations

impl Api

pub fn syntax(&self) -> Syntax

Returns the enum value of syntax, or the default if the field is set to an invalid enum value.

pub fn set_syntax(&mut self, value: Syntax)

Sets syntax to the provided enum value.

Trait Implementations

impl Clone for Api

pub fn clone(&self) -> Api

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Api

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

Formats the value using the given formatter.

impl Default for Api

pub fn default() -> Self

Returns the "default value" for a type.

impl Message for Api

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

pub fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

pub fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

pub 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<Api> for Api

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

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

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

This method tests for !=.

impl StructuralPartialEq for Api