Struct FieldOptions 

#[non_exhaustive]
pub struct FieldOptions {

    pub ctype: CType,
    pub packed: bool,
    pub jstype: JSType,
    pub lazy: bool,
    pub unverified_lazy: bool,
    pub deprecated: bool,
    pub weak: bool,
    pub debug_redact: bool,
    pub retention: OptionRetention,
    pub targets: Vec<OptionTargetType>,
    pub edition_defaults: Vec<EditionDefault>,
    pub features: Option<FeatureSet>,
    pub feature_support: Option<FeatureSupport>,
    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.

ctype: CType

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: 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: 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: 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: 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: 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: bool

For Google-internal migration only. Do not use.

debug_redact: bool

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

retention: OptionRetention

targets: Vec<OptionTargetType>

edition_defaults: Vec<EditionDefault>

features: Option<FeatureSet>

Any features defined in the specific edition.

feature_support: Option<FeatureSupport>

uninterpreted_option: Vec<UninterpretedOption>

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

Implementations

impl FieldOptions

pub fn new() -> Self

pub fn set_ctype<T: Into<CType>>(self, v: T) -> Self

Sets the value of ctype.

Example

use google_cloud_wkt::field_options::CType;
let x0 = FieldOptions::new().set_ctype(CType::Cord);
let x1 = FieldOptions::new().set_ctype(CType::StringPiece);

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

Sets the value of packed.

Example

let x = FieldOptions::new().set_packed(true);

pub fn set_jstype<T: Into<JSType>>(self, v: T) -> Self

Sets the value of jstype.

Example

use google_cloud_wkt::field_options::JSType;
let x0 = FieldOptions::new().set_jstype(JSType::JsString);
let x1 = FieldOptions::new().set_jstype(JSType::JsNumber);

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

Sets the value of lazy.

Example

let x = FieldOptions::new().set_lazy(true);

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

Sets the value of unverified_lazy.

Example

let x = FieldOptions::new().set_unverified_lazy(true);

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

Sets the value of deprecated.

Example

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

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

Sets the value of weak.

Example

let x = FieldOptions::new().set_weak(true);

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

Sets the value of debug_redact.

Example

let x = FieldOptions::new().set_debug_redact(true);

pub fn set_retention<T: Into<OptionRetention>>(self, v: T) -> Self

Sets the value of retention.

Example

use google_cloud_wkt::field_options::OptionRetention;
let x0 = FieldOptions::new().set_retention(OptionRetention::RetentionRuntime);
let x1 = FieldOptions::new().set_retention(OptionRetention::RetentionSource);

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

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

Sets the value of targets.

Example

use google_cloud_wkt::field_options::OptionTargetType;
let x = FieldOptions::new().set_targets([
    OptionTargetType::TargetTypeFile,
    OptionTargetType::TargetTypeExtensionRange,
    OptionTargetType::TargetTypeMessage,
]);

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

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

Sets the value of edition_defaults.

Example

use google_cloud_wkt::field_options::EditionDefault;
let x = FieldOptions::new()
    .set_edition_defaults([
        EditionDefault::default()/* use setters */,
        EditionDefault::default()/* use (different) setters */,
    ]);

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 = FieldOptions::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 = FieldOptions::new().set_or_clear_features(Some(FeatureSet::default()/* use setters */));
let x = FieldOptions::new().set_or_clear_features(None::<FeatureSet>);

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

where T: Into<FeatureSupport>,

Sets the value of feature_support.

Example

use google_cloud_wkt::field_options::FeatureSupport;
let x = FieldOptions::new().set_feature_support(FeatureSupport::default()/* use setters */);

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

where T: Into<FeatureSupport>,

Sets or clears the value of feature_support.

Example

use google_cloud_wkt::field_options::FeatureSupport;
let x = FieldOptions::new().set_or_clear_feature_support(Some(FeatureSupport::default()/* use setters */));
let x = FieldOptions::new().set_or_clear_feature_support(None::<FeatureSupport>);

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 = FieldOptions::new()
    .set_uninterpreted_option([
        UninterpretedOption::default()/* use setters */,
        UninterpretedOption::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for FieldOptions

fn clone(&self) -> FieldOptions

Returns a duplicate 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 Message for FieldOptions

fn typename() -> &'static str

The typename of this message.

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