Struct DynamicField

#[non_exhaustive]
pub struct DynamicField {
    pub kind: Option<i32>,
    pub parent: Option<String>,
    pub field_id: Option<String>,
    pub field_object: Option<Object>,
    pub name: Option<Bcs>,
    pub value: Option<Bcs>,
    pub value_type: Option<String>,
    pub child_id: Option<String>,
    pub child_object: Option<Object>,
}

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.

kind: Option<i32>

parent: Option<String>

ObjectId of this dynamic field’s parent.

field_id: Option<String>

ObjectId of this dynamic field.

field_object: Option<Object>

The field object itself

name: Option<Bcs>

The dynamic field’s “name”

value: Option<Bcs>

The dynamic field’s “value”

value_type: Option<String>

The type of the dynamic field “value”.

If this is a dynamic object field then this is the type of the object itself (which is a child of this field), otherwise this is the type of the value of this field.

child_id: Option<String>

The ObjectId of the child object when a child is a dynamic object field.

The presence or absence of this field can be used to determine if a child is a dynamic field or a dynamic child object

child_object: Option<Object>

The object itself when a child is a dynamic object field.

Implementations

impl DynamicField

pub const KIND_FIELD: &'static MessageField

pub const PARENT_FIELD: &'static MessageField

pub const FIELD_ID_FIELD: &'static MessageField

pub const FIELD_OBJECT_FIELD: &'static MessageField

pub const NAME_FIELD: &'static MessageField

pub const VALUE_FIELD: &'static MessageField

pub const VALUE_TYPE_FIELD: &'static MessageField

pub const CHILD_ID_FIELD: &'static MessageField

pub const CHILD_OBJECT_FIELD: &'static MessageField

impl DynamicField

pub fn path_builder() -> DynamicFieldFieldPathBuilder

impl DynamicField

pub const fn const_default() -> Self

pub fn with_kind<T: Into<DynamicFieldKind>>(self, field: T) -> Self

Sets kind with the provided value.

pub fn parent_opt_mut(&mut self) -> Option<&mut String>

If parent is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn parent_mut(&mut self) -> &mut String

Returns a mutable reference to parent. If the field is unset, it is first initialized with the default value.

pub fn parent_opt(&self) -> Option<&str>

If parent is set, returns Some with the value; otherwise returns None.

pub fn set_parent<T: Into<String>>(&mut self, field: T)

Sets parent with the provided value.

pub fn with_parent<T: Into<String>>(self, field: T) -> Self

Sets parent with the provided value.

pub fn field_id_opt_mut(&mut self) -> Option<&mut String>

If field_id is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn field_id_mut(&mut self) -> &mut String

Returns a mutable reference to field_id. If the field is unset, it is first initialized with the default value.

pub fn field_id_opt(&self) -> Option<&str>

If field_id is set, returns Some with the value; otherwise returns None.

pub fn set_field_id<T: Into<String>>(&mut self, field: T)

Sets field_id with the provided value.

pub fn with_field_id<T: Into<String>>(self, field: T) -> Self

Sets field_id with the provided value.

pub fn field_object(&self) -> &Object

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

pub fn field_object_opt_mut(&mut self) -> Option<&mut Object>

If field_object is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn field_object_mut(&mut self) -> &mut Object

Returns a mutable reference to field_object. If the field is unset, it is first initialized with the default value.

pub fn field_object_opt(&self) -> Option<&Object>

If field_object is set, returns Some with the value; otherwise returns None.

pub fn set_field_object<T: Into<Object>>(&mut self, field: T)

Sets field_object with the provided value.

pub fn with_field_object<T: Into<Object>>(self, field: T) -> Self

Sets field_object with the provided value.

pub fn name(&self) -> &Bcs

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

pub fn name_opt_mut(&mut self) -> Option<&mut Bcs>

If name is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn name_mut(&mut self) -> &mut Bcs

Returns a mutable reference to name. If the field is unset, it is first initialized with the default value.

pub fn name_opt(&self) -> Option<&Bcs>

If name is set, returns Some with the value; otherwise returns None.

pub fn set_name<T: Into<Bcs>>(&mut self, field: T)

Sets name with the provided value.

pub fn with_name<T: Into<Bcs>>(self, field: T) -> Self

Sets name with the provided value.

pub fn value(&self) -> &Bcs

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

pub fn value_opt_mut(&mut self) -> Option<&mut Bcs>

If value is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn value_mut(&mut self) -> &mut Bcs

Returns a mutable reference to value. If the field is unset, it is first initialized with the default value.

pub fn value_opt(&self) -> Option<&Bcs>

If value is set, returns Some with the value; otherwise returns None.

pub fn set_value<T: Into<Bcs>>(&mut self, field: T)

Sets value with the provided value.

pub fn with_value<T: Into<Bcs>>(self, field: T) -> Self

Sets value with the provided value.

pub fn value_type_opt_mut(&mut self) -> Option<&mut String>

If value_type is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn value_type_mut(&mut self) -> &mut String

Returns a mutable reference to value_type. If the field is unset, it is first initialized with the default value.

pub fn value_type_opt(&self) -> Option<&str>

If value_type is set, returns Some with the value; otherwise returns None.

pub fn set_value_type<T: Into<String>>(&mut self, field: T)

Sets value_type with the provided value.

pub fn with_value_type<T: Into<String>>(self, field: T) -> Self

Sets value_type with the provided value.

pub fn child_id_opt_mut(&mut self) -> Option<&mut String>

If child_id is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn child_id_mut(&mut self) -> &mut String

Returns a mutable reference to child_id. If the field is unset, it is first initialized with the default value.

pub fn child_id_opt(&self) -> Option<&str>

If child_id is set, returns Some with the value; otherwise returns None.

pub fn set_child_id<T: Into<String>>(&mut self, field: T)

Sets child_id with the provided value.

pub fn with_child_id<T: Into<String>>(self, field: T) -> Self

Sets child_id with the provided value.

pub fn child_object(&self) -> &Object

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

pub fn child_object_opt_mut(&mut self) -> Option<&mut Object>

If child_object is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn child_object_mut(&mut self) -> &mut Object

Returns a mutable reference to child_object. If the field is unset, it is first initialized with the default value.

pub fn child_object_opt(&self) -> Option<&Object>

If child_object is set, returns Some with the value; otherwise returns None.

pub fn set_child_object<T: Into<Object>>(&mut self, field: T)

Sets child_object with the provided value.

pub fn with_child_object<T: Into<Object>>(self, field: T) -> Self

Sets child_object with the provided value.

impl DynamicField

pub fn kind(&self) -> DynamicFieldKind

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

pub fn set_kind(&mut self, value: DynamicFieldKind)

Sets kind to the provided enum value.

pub fn parent(&self) -> &str

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

pub fn field_id(&self) -> &str

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

pub fn value_type(&self) -> &str

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

pub fn child_id(&self) -> &str

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

Trait Implementations

impl Clone for DynamicField

fn clone(&self) -> DynamicField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DynamicField

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

Formats the value using the given formatter.

impl Default for DynamicField

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DynamicField

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for DynamicField

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 MessageFields for DynamicField

const FIELDS: &'static [&'static MessageField]

impl PartialEq for DynamicField

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DynamicField