Struct protobuf::descriptor::FieldOptions

pub struct FieldOptions {
    pub ctype: Option<EnumOrUnknown<CType>>,
    pub packed: Option<bool>,
    pub jstype: Option<EnumOrUnknown<JSType>>,
    pub lazy: Option<bool>,
    pub deprecated: Option<bool>,
    pub weak: Option<bool>,
    pub uninterpreted_option: Vec<UninterpretedOption>,
    pub special_fields: SpecialFields,
}

Fields

ctype: Option<EnumOrUnknown<CType>>

The ctype option instructs the C++ code generator to use a different representation of the field than it normally would. See the specific options below. This option is not yet implemented in the open source release – sorry, we’ll try to include it in a future version!

packed: Option<bool>

The packed option can be enabled for repeated primitive fields to enable a more efficient representation on the wire. Rather than repeatedly writing the tag and type for each element, the entire array is encoded as a single length-delimited blob. In proto3, only explicit setting it to false will avoid using packed encoding.

jstype: Option<EnumOrUnknown<JSType>>

The jstype option determines the JavaScript type used for values of the field. The option is permitted only for 64 bit integral and fixed types (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING is represented as JavaScript string, which avoids loss of precision that can happen when a large value is converted to a floating point JavaScript. Specifying JS_NUMBER for the jstype causes the generated JavaScript code to use the JavaScript “number” type. The behavior of the default option JS_NORMAL is implementation dependent.

This option is an enum to permit additional types to be added, e.g. goog.math.Integer.

lazy: Option<bool>

Should this field be parsed lazily? Lazy applies only to message-type fields. It means that when the outer message is initially parsed, the inner message’s contents will not be parsed but instead stored in encoded form. The inner message will actually be parsed when it is first accessed.

This is only a hint. Implementations are free to choose whether to use eager or lazy parsing regardless of the value of this option. However, setting this option true suggests that the protocol author believes that using lazy parsing on this field is worth the additional bookkeeping overhead typically needed to implement it.

This option does not affect the public interface of any generated code; all method signatures remain the same. Furthermore, thread-safety of the interface is not affected by this option; const methods remain safe to call from multiple threads concurrently, while non-const methods continue to require exclusive access.

Note that implementations may choose not to check required fields within a lazy sub-message. That is, calling IsInitialized() on the outer message may return true even if the inner message has missing required fields. This is necessary because otherwise the inner message would have to be parsed in order to perform the check, defeating the purpose of lazy parsing. An implementation which chooses not to check required fields must be consistent about it. That is, for any particular sub-message, the implementation must either always check its required fields, or never check its required fields, regardless of whether or not the message has been parsed.

deprecated: Option<bool>

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

weak: Option<bool>

For Google-internal migration only. Do not use.

uninterpreted_option: Vec<UninterpretedOption>

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

special_fields: SpecialFields

Implementations

impl FieldOptions

pub fn new() -> FieldOptions

pub fn ctype(&self) -> CType

pub fn clear_ctype(&mut self)

pub fn has_ctype(&self) -> bool

pub fn set_ctype(&mut self, v: CType)

pub fn packed(&self) -> bool

pub fn clear_packed(&mut self)

pub fn has_packed(&self) -> bool

pub fn set_packed(&mut self, v: bool)

pub fn jstype(&self) -> JSType

pub fn clear_jstype(&mut self)

pub fn has_jstype(&self) -> bool

pub fn set_jstype(&mut self, v: JSType)

pub fn lazy(&self) -> bool

pub fn clear_lazy(&mut self)

pub fn has_lazy(&self) -> bool

pub fn set_lazy(&mut self, v: bool)

pub fn deprecated(&self) -> bool

pub fn clear_deprecated(&mut self)

pub fn has_deprecated(&self) -> bool

pub fn set_deprecated(&mut self, v: bool)

pub fn weak(&self) -> bool

pub fn clear_weak(&mut self)

pub fn has_weak(&self) -> bool

pub fn set_weak(&mut self, v: bool)

Trait Implementations

impl Clone for FieldOptions

fn clone(&self) -> FieldOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldOptions

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

Formats the value using the given formatter.

impl Default for FieldOptions

fn default() -> FieldOptions

Returns the “default value” for a type.

impl<'a> Default for &'a FieldOptions

fn default() -> &'a FieldOptions

Returns the “default value” for a type.

impl Display for FieldOptions

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

Formats the value using the given formatter.

impl Message for FieldOptions

const NAME: &'static str = "FieldOptions"

Message name as specified in .proto file.

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<'_>) -> Result<()>

Update this message object with fields read from given stream.

fn compute_size(&self) -> u64

Compute and cache size of this message and all nested messages.

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

Write message to the stream.

fn special_fields(&self) -> &SpecialFields

Special fields (unknown fields and cached size).

fn mut_special_fields(&mut self) -> &mut SpecialFields

Special fields (unknown fields and cached size).

fn new() -> FieldOptions

Create an empty message object.

fn clear(&mut self)

Reset all fields.

fn default_instance() -> &'static FieldOptions

Return a pointer to default immutable message with static lifetime.

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

Parse message from stream.

fn cached_size(&self) -> u32

Get size previously computed by compute_size.

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

Write the message to the stream.

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

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>) -> Result<()>

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

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

Update this message object with fields read from given stream.

fn parse_from_reader(reader: &mut dyn Read) -> Result<Self>

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

fn parse_from_bytes(bytes: &[u8]) -> Result<Self>

Parse message from byte array.

fn parse_from_tokio_bytes(bytes: &Bytes) -> Result<Self>

Parse message from Bytes object. Resulting message may share references to the passed bytes object.

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

Check if all required fields of this object are initialized.

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

Write the message to the writer.

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

Write the message to bytes vec.

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

Write the message to bytes vec.

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

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

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

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

fn 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.

impl MessageFull for FieldOptions

fn descriptor() -> MessageDescriptor

Get message descriptor for message type.

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

Reflective equality.

impl PartialEq<FieldOptions> for FieldOptions

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

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

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

This method tests for !=.

impl ProtobufValue for FieldOptions

type RuntimeType = RuntimeTypeMessage<FieldOptions>

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?

fn cast_to_enum_values(values: &[Self]) -> &[i32]

Cast enum element data to integers.

impl StructuralPartialEq for FieldOptions