Struct MessageOptionsView 

pub struct MessageOptionsView { /* private fields */ }

Implementations

impl MessageOptionsView

pub fn message_set_wire_format(&self) -> bool

pub fn message_set_wire_format_opt(&self) -> Option<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.

pub fn has_message_set_wire_format(&self) -> bool

pub fn no_standard_descriptor_accessor(&self) -> bool

pub fn no_standard_descriptor_accessor_opt(&self) -> Option<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”.

pub fn has_no_standard_descriptor_accessor(&self) -> bool

pub fn deprecated(&self) -> bool

pub fn deprecated_opt(&self) -> Option<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.

pub fn has_deprecated(&self) -> bool

pub fn map_entry(&self) -> bool

pub fn map_entry_opt(&self) -> Option<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.

pub fn has_map_entry(&self) -> bool

pub fn uninterpreted_option( &self, ) -> impl '_ + RepeatedFieldView<'_, Item = UninterpretedOptionView>

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

Trait Implementations

impl Borrow<MessageOptionsView> for MessageOptions

fn borrow(&self) -> &MessageOptionsView

Immutably borrows from an owned value.

impl Debug for MessageOptionsView

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

Formats the value using the given formatter.

impl Drop for MessageOptionsView

fn drop(&mut self)

Executes the destructor for this type.

impl MessageView for MessageOptionsView

type MessageType = MessageOptions

fn to_bytes<W: Write>(&self, out: &mut W) -> Result<()>

impl MessageViewInternal for MessageOptionsView

fn new_boxed() -> Box<Self>

impl PartialEq for MessageOptionsView

fn eq(&self, rhs: &Self) -> 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 ToOwned for MessageOptionsView

type Owned = MessageOptions

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.