Enum JsonStructureSettings 

pub enum JsonStructureSettings {
    Structured(Option<StructType>),
    UnstructuredRaw,
    PartialUnstructuredByKey {
        fields: Option<StructType>,
        unstructured_keys: HashSet<String>,
    },
}

The configuration of JSON encoding

The enum describes how we handle JSON encoding to StructValue internally. It defines three configurations:

• Structured: Encodes JSON objects as StructValue with an optional predefined StructType.
• UnstructuredRaw: Encodes JSON data as string and store it in a struct with a field named “_raw”.
• PartialUnstructuredByKey: Encodes JSON objects as StructValue with an optional predefined StructType and a set of unstructured keys, these keys are provided as flattened names, for example: a.b.c.

We provide a few methods to convert JSON data to StructValue based on the settings. And we also convert them to fully structured StructValue for user-facing APIs: the UI protocol and the UDF interface.

Important: This settings only controls the internal form of JSON encoding.

Variants

Structured(Option<StructType>)

UnstructuredRaw

PartialUnstructuredByKey

Fields

fields: Option<StructType>

unstructured_keys: HashSet<String>

Implementations

impl JsonStructureSettings

pub const RAW_FIELD: &'static str = "_raw"

pub fn decode(&self, value: Value) -> Result<Json, Error>

Decode an encoded StructValue back into a serde_json::Value.

pub fn decode_struct( &self, struct_value: StructValue, ) -> Result<StructValue, Error>

Decode a StructValue that was encoded with current settings back into a fully structured StructValue. This is useful for reconstructing the original structure from encoded data, especially when unstructured encoding was used for some fields.

pub fn encode(&self, json: Json) -> Result<Value, Error>

Encode a serde_json::Value into a Value::Json using current settings.

pub fn encode_with_type( &self, json: Json, data_type: Option<&ConcreteDataType>, ) -> Result<Value, Error>

Encode a serde_json::Value into a Value::Json with given data type.

Trait Implementations

impl Clone for JsonStructureSettings

fn clone(&self) -> JsonStructureSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsonStructureSettings

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

Formats the value using the given formatter.

impl Default for JsonStructureSettings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JsonStructureSettings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for JsonStructureSettings

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.