Struct FieldDescriptorProto 

#[non_exhaustive]
pub struct FieldDescriptorProto {
    pub name: String,
    pub number: i32,
    pub label: Label,
    pub type: Type,
    pub type_name: String,
    pub extendee: String,
    pub default_value: String,
    pub oneof_index: i32,
    pub json_name: String,
    pub options: Option<FieldOptions>,
    pub proto3_optional: bool,
    /* private fields */
}

Describes a field within a message.

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

number: i32

label: Label

type: Type

If type_name is set, this need not be set. If both this and type_name are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.

type_name: String

For message and enum types, this is the name of the type. If the name starts with a ‘.’, it is fully-qualified. Otherwise, C++-like scoping rules are used to find the type (i.e. first the nested types within this message are searched, then within the parent, on up to the root namespace).

extendee: String

For extensions, this is the name of the type being extended. It is resolved in the same manner as type_name.

default_value: String

For numeric types, contains the original text representation of the value. For booleans, “true” or “false”. For strings, contains the default text contents (not escaped in any way). For bytes, contains the C escaped value. All bytes >= 128 are escaped.

oneof_index: i32

If set, gives the index of a oneof in the containing type’s oneof_decl list. This field is a member of that oneof.

json_name: String

JSON name of this field. The value is set by protocol compiler. If the user has set a “json_name” option on this field, that option’s value will be used. Otherwise, it’s deduced from the field’s name by converting it to camelCase.

options: Option<FieldOptions>

proto3_optional: bool

If true, this is a proto3 “optional”. When a proto3 field is optional, it tracks presence regardless of field type.

When proto3_optional is true, this field must belong to a oneof to signal to old proto3 clients that presence is tracked for this field. This oneof is known as a “synthetic” oneof, and this field must be its sole member (each proto3 optional field gets its own synthetic oneof). Synthetic oneofs exist in the descriptor only, and do not generate any API. Synthetic oneofs must be ordered after all “real” oneofs.

For message fields, proto3_optional doesn’t create any semantic change, since non-repeated message fields always track presence. However it still indicates the semantic detail of whether the user wrote “optional” or not. This can be useful for round-tripping the .proto file. For consistency we give message fields a synthetic oneof also, even though it is not required to track presence. This is especially important because the parser can’t tell if a field is a message or an enum, so it must always create a synthetic oneof.

Proto2 optional fields do not set this flag, because they already indicate optional with LABEL_OPTIONAL.

Implementations

impl FieldDescriptorProto

pub fn new() -> Self

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

Sets the value of name.

Example

let x = FieldDescriptorProto::new().set_name("example");

pub fn set_number<T: Into<i32>>(self, v: T) -> Self

Sets the value of number.

Example

let x = FieldDescriptorProto::new().set_number(42);

pub fn set_label<T: Into<Label>>(self, v: T) -> Self

Sets the value of label.

Example

use google_cloud_wkt::field_descriptor_proto::Label;
let x0 = FieldDescriptorProto::new().set_label(Label::Optional);
let x1 = FieldDescriptorProto::new().set_label(Label::Repeated);
let x2 = FieldDescriptorProto::new().set_label(Label::Required);

pub fn set_type<T: Into<Type>>(self, v: T) -> Self

Sets the value of r#type.

Example

use google_cloud_wkt::field_descriptor_proto::Type;
let x0 = FieldDescriptorProto::new().set_type(Type::Double);
let x1 = FieldDescriptorProto::new().set_type(Type::Float);
let x2 = FieldDescriptorProto::new().set_type(Type::Int64);

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

Sets the value of type_name.

Example

let x = FieldDescriptorProto::new().set_type_name("example");

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

Sets the value of extendee.

Example

let x = FieldDescriptorProto::new().set_extendee("example");

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

Sets the value of default_value.

Example

let x = FieldDescriptorProto::new().set_default_value("example");

pub fn set_oneof_index<T: Into<i32>>(self, v: T) -> Self

Sets the value of oneof_index.

Example

let x = FieldDescriptorProto::new().set_oneof_index(42);

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

Sets the value of json_name.

Example

let x = FieldDescriptorProto::new().set_json_name("example");

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

where T: Into<FieldOptions>,

Sets the value of options.

Example

use google_cloud_wkt::FieldOptions;
let x = FieldDescriptorProto::new().set_options(FieldOptions::default()/* use setters */);

pub fn set_or_clear_options<T>(self, v: Option<T>) -> Self

where T: Into<FieldOptions>,

Sets or clears the value of options.

Example

use google_cloud_wkt::FieldOptions;
let x = FieldDescriptorProto::new().set_or_clear_options(Some(FieldOptions::default()/* use setters */));
let x = FieldDescriptorProto::new().set_or_clear_options(None::<FieldOptions>);

pub fn set_proto3_optional<T: Into<bool>>(self, v: T) -> Self

Sets the value of proto3_optional.

Example

let x = FieldDescriptorProto::new().set_proto3_optional(true);

Trait Implementations

impl Clone for FieldDescriptorProto

fn clone(&self) -> FieldDescriptorProto

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldDescriptorProto

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

Formats the value using the given formatter.

impl Default for FieldDescriptorProto

fn default() -> FieldDescriptorProto

Returns the “default value” for a type.

impl Message for FieldDescriptorProto

fn typename() -> &'static str

The typename of this message.

impl PartialEq for FieldDescriptorProto

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