Struct MessageOptions 

#[non_exhaustive]
pub struct MessageOptions {
    pub message_set_wire_format: bool,
    pub no_standard_descriptor_accessor: bool,
    pub deprecated: bool,
    pub map_entry: bool,
    pub deprecated_legacy_json_field_conflicts: bool,
    pub features: Option<FeatureSet>,
    pub uninterpreted_option: Vec<UninterpretedOption>,
    /* private fields */
}

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.

message_set_wire_format: bool

Set true to use the old proto1 MessageSet wire format for extensions. This is provided for backwards-compatibility with the MessageSet wire format. You should not use this for any other reason: It’s less efficient, has fewer features, and is more complicated.

The message must be defined exactly as follows: message Foo { option message_set_wire_format = true; extensions 4 to max; } Note that the message cannot have any defined fields; MessageSets only have extensions.

All extensions of your type must be singular messages; e.g. they cannot be int32s, enums, or repeated messages.

Because this is an option, the above two restrictions are not enforced by the protocol compiler.

no_standard_descriptor_accessor: bool

Disables the generation of the standard “descriptor()” accessor, which can conflict with a field of the same name. This is meant to make migration from proto1 easier; new code should avoid fields named “descriptor”.

deprecated: bool

Is this message deprecated? Depending on the target platform, this can emit Deprecated annotations for the message, or it will be completely ignored; in the very least, this is a formalization for deprecating messages.

map_entry: bool

Whether the message is an automatically generated map entry type for the maps field.

For maps fields: map<KeyType, ValueType> map_field = 1; The parsed descriptor looks like: message MapFieldEntry { option map_entry = true; optional KeyType key = 1; optional ValueType value = 2; } repeated MapFieldEntry map_field = 1;

Implementations may choose not to generate the map_entry=true message, but use a native map in the target language to hold the keys and values. The reflection APIs in such implementations still need to work as if the field is a repeated message field.

NOTE: Do not set the option in .proto files. Always use the maps syntax instead. The option should only be implicitly set by the proto compiler parser.

deprecated_legacy_json_field_conflicts: bool

👎Deprecated

Enable the legacy handling of JSON field name conflicts. This lowercases and strips underscored from the fields before comparison in proto3 only. The new behavior takes json_name into account and applies to proto2 as well.

This should only be used as a temporary measure against broken builds due to the change in behavior for JSON field name conflicts.

TODO This is legacy behavior we plan to remove once downstream teams have had time to migrate.

features: Option<FeatureSet>

Any features defined in the specific edition.

uninterpreted_option: Vec<UninterpretedOption>

The parser stores options it doesn’t recognize here. See above.

Implementations

impl MessageOptions

pub fn new() -> Self

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

Sets the value of message_set_wire_format.

Example

let x = MessageOptions::new().set_message_set_wire_format(true);

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

Sets the value of no_standard_descriptor_accessor.

Example

let x = MessageOptions::new().set_no_standard_descriptor_accessor(true);

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

Sets the value of deprecated.

Example

let x = MessageOptions::new().set_deprecated(true);

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

Sets the value of map_entry.

Example

let x = MessageOptions::new().set_map_entry(true);

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

👎Deprecated

Sets the value of deprecated_legacy_json_field_conflicts.

Example

let x = MessageOptions::new().set_deprecated_legacy_json_field_conflicts(true);

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

where T: Into<FeatureSet>,

Sets the value of features.

Example

use google_cloud_wkt::FeatureSet;
let x = MessageOptions::new().set_features(FeatureSet::default()/* use setters */);

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

where T: Into<FeatureSet>,

Sets or clears the value of features.

Example

use google_cloud_wkt::FeatureSet;
let x = MessageOptions::new().set_or_clear_features(Some(FeatureSet::default()/* use setters */));
let x = MessageOptions::new().set_or_clear_features(None::<FeatureSet>);

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

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

Sets the value of uninterpreted_option.

Example

use google_cloud_wkt::UninterpretedOption;
let x = MessageOptions::new()
    .set_uninterpreted_option([
        UninterpretedOption::default()/* use setters */,
        UninterpretedOption::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for MessageOptions

fn clone(&self) -> MessageOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageOptions

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

Formats the value using the given formatter.

impl Default for MessageOptions

fn default() -> MessageOptions

Returns the “default value” for a type.

impl Message for MessageOptions

fn typename() -> &'static str

The typename of this message.

impl PartialEq for MessageOptions

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