Struct FieldOptions

pub struct FieldOptions {
    pub rename: Option<String>,
    pub json_omittable: i32,
    pub flatten: Option<bool>,
    pub visibility: Option<i32>,
    pub constraint: Option<FieldConstraints>,
}

Fields

rename: Option<String>

Rename this specific field to another name.

json_omittable: i32

Deserialization: This flag dictates how we handle fields which are not provided in the json representation of the message. If this is true, then no error will be returned if the field is not provided. If this is false then not providing a value for this field will result in an error.

Serialization: This flag dictates if we should skip serializing the field in the json representation of the message if the field is equal to the default value for its type.

By default if the value depends on the type of field. If the field is an option then the default value is TRUE_BUT_SERIALIZE which means that the option does not need to be provided but a null value will always be serialized. If the field is not an option then it will be required so FALSE.

flatten: Option<bool>

Flatten this field into the parent message. This only works on messages.

visibility: Option<i32>

Change the visibility of the field. By Default all fields are visible.

constraint: Option<FieldConstraints>

Add some constraints to the field.

Implementations

impl FieldOptions

pub fn rename(&self) -> &str

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

pub fn json_omittable(&self) -> JsonOmittable

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

pub fn set_json_omittable(&mut self, value: JsonOmittable)

Sets json_omittable to the provided enum value.

pub fn visibility(&self) -> Visibility

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

pub fn set_visibility(&mut self, value: Visibility)

Sets visibility to the provided enum value.

pub fn flatten(&self) -> bool

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

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