Struct Mapping

#[non_exhaustive]
pub struct Mapping {
    pub to_key: Option<String>,
    pub from_path: Option<Vec<String>>,
    pub from_type: Option<String>,
    pub to_type: Option<String>,
    pub dropped: Option<bool>,
    pub children: Option<Vec<Mapping>>,
}

Specifies the mapping of data property keys.

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.

to_key: Option<String>

After the apply mapping, what the name of the column should be. Can be the same as FromPath.

from_path: Option<Vec<String>>

The table or column to be modified.

from_type: Option<String>

The type of the data to be modified.

to_type: Option<String>

The data type that the data is to be modified to.

dropped: Option<bool>

If true, then the column is removed.

children: Option<Vec<Mapping>>

Only applicable to nested data structures. If you want to change the parent structure, but also one of its children, you can fill out this data strucutre. It is also Mapping, but its FromPath will be the parent's FromPath plus the FromPath from this structure.

For the children part, suppose you have the structure:

{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": \[{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }\] }

You can specify a Mapping that looks like:

{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": \[{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }\] }

Implementations

impl Mapping

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

After the apply mapping, what the name of the column should be. Can be the same as FromPath.

pub fn from_path(&self) -> &[String]

The table or column to be modified.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .from_path.is_none().

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

The type of the data to be modified.

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

The data type that the data is to be modified to.

pub fn dropped(&self) -> Option<bool>

If true, then the column is removed.

pub fn children(&self) -> &[Mapping]

Only applicable to nested data structures. If you want to change the parent structure, but also one of its children, you can fill out this data strucutre. It is also Mapping, but its FromPath will be the parent's FromPath plus the FromPath from this structure.

For the children part, suppose you have the structure:

{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": \[{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }\] }

You can specify a Mapping that looks like:

{ "FromPath": "OuterStructure", "ToKey": "OuterStructure", "ToType": "Struct", "Dropped": false, "Chidlren": \[{ "FromPath": "inner", "ToKey": "inner", "ToType": "Double", "Dropped": false, }\] }

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .children.is_none().

impl Mapping

pub fn builder() -> MappingBuilder

Creates a new builder-style object to manufacture Mapping.

Trait Implementations

impl Clone for Mapping

fn clone(&self) -> Mapping

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mapping

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

Formats the value using the given formatter.

impl PartialEq for Mapping

fn eq(&self, other: &Mapping) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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 Mapping