Struct FieldOptions

pub struct FieldOptions {

    pub ctype: Option<i32>,
    pub packed: Option<bool>,
    pub jstype: Option<i32>,
    pub lazy: Option<bool>,
    pub unverified_lazy: Option<bool>,
    pub deprecated: Option<bool>,
    pub weak: Option<bool>,
    pub debug_redact: Option<bool>,
    pub retention: Option<i32>,
    pub targets: Vec<i32>,
    pub edition_defaults: Vec<EditionDefault>,
    pub features: Option<FeatureSet>,
    pub feature_support: Option<FeatureSupport>,
    pub uninterpreted_option: Vec<UninterpretedOption>,
}

Fields

ctype: Option<i32>

NOTE: ctype is deprecated. Use features.(pb.cpp).string_type instead. 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 only implemented to support use of [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of type “bytes” in the open source release. TODO: make ctype actually deprecated.

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. This option is prohibited in Editions, but the repeated_field_encoding feature can be used to control the behavior.

jstype: Option<i32>

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 lazy message fields are still eagerly verified to check ill-formed wireformat or missing required fields. Calling IsInitialized() on the outer message would fail if the inner message has missing required fields. Failed verification would result in parsing failure (except when uninitialized messages are acceptable).

unverified_lazy: Option<bool>

unverified_lazy does no correctness checks on the byte stream. This should only be used where lazy with verification is prohibitive for performance reasons.

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.

debug_redact: Option<bool>

Indicate that the field value should not be printed out when using debug formats, e.g. when the field contains sensitive credentials.

retention: Option<i32>

targets: Vec<i32>

edition_defaults: Vec<EditionDefault>

features: Option<FeatureSet>

Any features defined in the specific edition. WARNING: This field should only be used by protobuf plugins or special cases like the proto compiler. Other uses are discouraged and developers should rely on the protoreflect APIs for their client language.

feature_support: Option<FeatureSupport>

uninterpreted_option: Vec<UninterpretedOption>

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

Implementations

impl FieldOptions

pub fn ctype(&self) -> CType

Returns the enum value of ctype, or the default if the field is unset or set to an invalid enum value.

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

Sets ctype to the provided enum value.

pub fn packed(&self) -> bool

Returns the value of packed, or the default value if packed is unset.

pub fn deprecated(&self) -> bool

Returns the value of deprecated, or the default value if deprecated is unset.

pub fn lazy(&self) -> bool

Returns the value of lazy, or the default value if lazy is unset.

pub fn jstype(&self) -> JsType

Returns the enum value of jstype, or the default if the field is unset or set to an invalid enum value.

pub fn set_jstype(&mut self, value: JsType)

Sets jstype to the provided enum value.

pub fn weak(&self) -> bool

Returns the value of weak, or the default value if weak is unset.

pub fn unverified_lazy(&self) -> bool

Returns the value of unverified_lazy, or the default value if unverified_lazy is unset.

pub fn debug_redact(&self) -> bool

Returns the value of debug_redact, or the default value if debug_redact is unset.

pub fn retention(&self) -> OptionRetention

Returns the enum value of retention, or the default if the field is unset or set to an invalid enum value.

pub fn set_retention(&mut self, value: OptionRetention)

Sets retention to the provided enum value.

pub fn targets( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(i32) -> Option<OptionTargetType>>

Returns an iterator which yields the valid enum values contained in targets.

pub fn push_targets(&mut self, value: OptionTargetType)

Appends the provided enum value to targets.

Trait Implementations

impl Clone for FieldOptions

fn clone(&self) -> FieldOptions

Returns a duplicate of the value.

const 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() -> Self

Returns the “default value” for a type.

impl Message for FieldOptions

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for FieldOptions

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