Struct protobuf::well_known_types::Api

pub struct Api {
    pub name: String,
    pub methods: Vec<Method>,
    pub options: Vec<Option>,
    pub version: String,
    pub source_context: MessageField<SourceContext>,
    pub mixins: Vec<Mixin>,
    pub syntax: ProtobufEnumOrUnknown<Syntax>,
    pub unknown_fields: UnknownFields,
    pub cached_size: CachedSize,
}

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: MessageField<SourceContext>

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

mixins: Vec<Mixin>

Included interfaces. See Mixin.

syntax: ProtobufEnumOrUnknown<Syntax>

The source syntax of the service.

unknown_fields: UnknownFields

cached_size: CachedSize

Implementations

impl Api

pub fn new() -> Api

Trait Implementations

impl Clear for Api

fn clear(&mut self)

Clear this make, make it equivalent to newly created object.

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<'a> Default for &'a Api

fn default() -> &'a Api

Returns the “default value” for a type.

impl Message for Api

fn is_initialized(&self) -> bool

True iff all required fields are initialized. Always returns true for protobuf 3.

fn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> ProtobufResult<()>

Update this message object with fields read from given stream.

fn compute_size(&self) -> u32

Compute and cache size of this message and all nested messages

fn write_to_with_cached_sizes(
    &self,
    os: &mut CodedOutputStream<'_>
) -> ProtobufResult<()>

Write message to the stream.

fn get_cached_size(&self) -> u32

Get size previously computed by compute_size.

fn get_unknown_fields(&self) -> &UnknownFields

Get a reference to unknown fields.

fn mut_unknown_fields(&mut self) -> &mut UnknownFields

Get a mutable reference to unknown fields.

fn new() -> Api

Create an empty message object.

fn descriptor_static() -> MessageDescriptor

Get message descriptor for message type.

fn default_instance() -> &'static Api

Return a pointer to default immutable message with static lifetime.

fn descriptor_by_instance(&self) -> MessageDescriptor

Message descriptor for this message, used for reflection.

fn parse_from(is: &mut CodedInputStream<'_>) -> ProtobufResult<Self>

Parse message from stream.

fn write_to(&self, os: &mut CodedOutputStream<'_>) -> ProtobufResult<()>

Write the message to the stream.

fn write_length_delimited_to(
    &self,
    os: &mut CodedOutputStream<'_>
) -> ProtobufResult<()>

Write the message to the stream prepending the message with message length encoded as varint.

fn write_length_delimited_to_vec(&self, vec: &mut Vec<u8>) -> ProtobufResult<()>

Write the message to the vec, prepend the message with message length encoded as varint.

fn merge_from_bytes(&mut self, bytes: &[u8]) -> ProtobufResult<()>

Update this message object with fields read from given stream.

fn parse_from_reader(reader: &mut dyn Read) -> ProtobufResult<Self> where
    Self: Sized, 

Parse message from reader. Parse stops on EOF or when error encountered.

fn parse_from_bytes(bytes: &[u8]) -> ProtobufResult<Self> where
    Self: Sized, 

Parse message from byte array.

fn check_initialized(&self) -> ProtobufResult<()>

Check if all required fields of this object are initialized.

fn write_to_writer(&self, w: &mut dyn Write) -> ProtobufResult<()>

Write the message to the writer.

fn write_to_vec(&self, v: &mut Vec<u8>) -> ProtobufResult<()>

Write the message to bytes vec.

fn write_to_bytes(&self) -> ProtobufResult<Vec<u8>>

Write the message to bytes vec.

fn write_length_delimited_to_writer(
    &self,
    w: &mut dyn Write
) -> ProtobufResult<()>

Write the message to the writer, prepend the message with message length encoded as varint.

fn write_length_delimited_to_bytes(&self) -> ProtobufResult<Vec<u8>>

Write the message to the bytes vec, prepend the message with message length encoded as varint.

fn reflect_eq(&self, other: &Self, mode: &ReflectEqMode) -> bool

Reflective equality.

impl PartialEq<Api> for Api

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

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

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

This method tests for !=.

impl ProtobufValue for Api

type RuntimeType = RuntimeTypeMessage<Self>

Actual implementation of type properties.

fn runtime_type_box() -> RuntimeTypeBox

Dynamic version of the type.

fn as_ref(value: &Self) -> ReflectValueRef<'_>

Pointer to a dynamic reference.

fn as_mut(value: &mut Self) -> ReflectValueMut<'_>

Mutable pointer to a dynamic mutable reference.

fn from_value_box(value_box: ReflectValueBox) -> Result<Self, ReflectValueBox>

Construct a value from given reflective value.

fn set_from_value_box(target: &mut Self, value_box: ReflectValueBox)

Write the value.

fn default_value_ref() -> ReflectValueRef<'static>

Default value for this type.

fn into_static_value_ref(value: Self) -> ReflectValueRef<'static>

Convert a value into a ref value if possible.

fn is_non_zero(value: &Self) -> bool

Value is non-default?

impl StructuralPartialEq for Api