Struct prost_types::MessageOptions
[−]
[src]
pub struct MessageOptions { pub message_set_wire_format: Option<bool>, pub no_standard_descriptor_accessor: Option<bool>, pub deprecated: Option<bool>, pub map_entry: Option<bool>, pub uninterpreted_option: Vec<UninterpretedOption>, }
Fields
message_set_wire_format: 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.
no_standard_descriptor_accessor: 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".
deprecated: 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.
map_entry: Option<bool>
Whether the message is an automatically generated map entry type for the maps field.
For maps fields:
map
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 implementions 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.
uninterpreted_option: Vec<UninterpretedOption>
The parser stores options it doesn't recognize here. See above.
Methods
impl MessageOptions
[src]
fn message_set_wire_format(&self) -> bool
[src]
fn no_standard_descriptor_accessor(&self) -> bool
[src]
fn deprecated(&self) -> bool
[src]
fn map_entry(&self) -> bool
[src]
Trait Implementations
impl Message for MessageOptions
[src]
fn encode_raw<B>(&self, buf: &mut B) where
B: BufMut,
[src]
B: BufMut,
fn merge_field<B>(&mut self, buf: &mut B) -> Result<(), DecodeError> where
B: Buf,
[src]
B: Buf,
fn encoded_len(&self) -> usize
[src]
Returns the encoded length of the message without a length delimiter.
fn clear(&mut self)
[src]
Clears the message, resetting all fields to their default.
fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
B: BufMut,
[src]
B: BufMut,
Encodes the message to a buffer. Read more
fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
B: BufMut,
[src]
B: BufMut,
Encodes the message with a length-delimiter to a buffer. Read more
fn decode<B>(buf: B) -> Result<Self, DecodeError> where
B: IntoBuf,
Self: Default,
[src]
B: IntoBuf,
Self: Default,
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
B: IntoBuf,
Self: Default,
[src]
B: IntoBuf,
Self: Default,
Decodes a length-delimited instance of the message from the buffer.
fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
B: IntoBuf,
[src]
B: IntoBuf,
Decodes an instance of the message from a buffer, and merges it into self
. Read more
fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
B: IntoBuf,
[src]
B: IntoBuf,
Decodes a length-delimited instance of the message from buffer, and merges it into self
. Read more
impl Default for MessageOptions
[src]
fn default() -> MessageOptions
[src]
Returns the "default value" for a type. Read more
impl Clone for MessageOptions
[src]
fn clone(&self) -> MessageOptions
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Debug for MessageOptions
[src]
impl PartialEq for MessageOptions
[src]
fn eq(&self, __arg_0: &MessageOptions) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &MessageOptions) -> bool
[src]
This method tests for !=
.