#
k8s_openapi/v1_35/apimachinery/pkg/runtime/
raw_extension.rs

    1// Generated from definition io.k8s.apimachinery.pkg.runtime.RawExtension
    2
    3/// RawExtension is used to hold extensions in external versions.
    4///
    5/// To use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.
    6///
    7/// // Internal package:
    8///
    9///   type MyAPIObject struct {
    10///         runtime.TypeMeta `json:",inline"`
    11///         MyPlugin runtime.Object `json:"myPlugin"`
    12///     }
    13///
    14///   type PluginA struct {
    15///         AOption string `json:"aOption"`
    16///     }
    17///
    18/// // External package:
    19///
    20///   type MyAPIObject struct {
    21///         runtime.TypeMeta `json:",inline"`
    22///         MyPlugin runtime.RawExtension `json:"myPlugin"`
    23///     }
    24///
    25///   type PluginA struct {
    26///         AOption string `json:"aOption"`
    27///     }
    28///
    29/// // On the wire, the JSON will look something like this:
    30///
    31///   {
    32///         "kind":"MyAPIObject",
    33///         "apiVersion":"v1",
    34///         "myPlugin": {
    35///             "kind":"PluginA",
    36///             "aOption":"foo",
    37///         },
    38///     }
    39///
    40/// So what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package's DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)
    41#[derive(Clone, Debug, Default, PartialEq)]
    42pub struct RawExtension(pub crate::serde_json::Value);
    43
    44impl crate::DeepMerge for RawExtension {
    45    fn merge_from(&mut self, other: Self) {
    46        crate::DeepMerge::merge_from(&mut self.0, other.0);
    47    }
    48}
    49
    50impl<'de> crate::serde::Deserialize<'de> for RawExtension {
    51    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: crate::serde::Deserializer<'de> {
    52        struct Visitor;
    53
    54        impl<'de> crate::serde::de::Visitor<'de> for Visitor {
    55            type Value = RawExtension;
    56
    57            fn expecting(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
    58                f.write_str("RawExtension")
    59            }
    60
    61            fn visit_newtype_struct<D>(self, deserializer: D) -> Result<Self::Value, D::Error> where D: crate::serde::Deserializer<'de> {
    62                Ok(RawExtension(crate::serde::Deserialize::deserialize(deserializer)?))
    63            }
    64        }
    65
    66        deserializer.deserialize_newtype_struct("RawExtension", Visitor)
    67    }
    68}
    69
    70impl From<crate::serde_json::Value> for RawExtension {
    71    fn from(inner: crate::serde_json::Value) -> Self {
    72        Self(inner)
    73    }
    74}
    75
    76impl crate::serde::Serialize for RawExtension {
    77    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: crate::serde::Serializer {
    78        serializer.serialize_newtype_struct("RawExtension", &self.0)
    79    }
    80}
    81
    82#[cfg(feature = "schemars")]
    83impl crate::schemars::JsonSchema for RawExtension {
    84    fn schema_name() -> std::borrow::Cow<'static, str> {
    85        "io.k8s.apimachinery.pkg.runtime.RawExtension".into()
    86    }
    87
    88    fn json_schema(__gen: &mut crate::schemars::SchemaGenerator) -> crate::schemars::Schema {
    89        crate::schemars::json_schema!({
    90            "description": "RawExtension is used to hold extensions in external versions.\n\nTo use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.\n\n// Internal package:\n\n\ttype MyAPIObject struct {\n\t\truntime.TypeMeta `json:\",inline\"`\n\t\tMyPlugin runtime.Object `json:\"myPlugin\"`\n\t}\n\n\ttype PluginA struct {\n\t\tAOption string `json:\"aOption\"`\n\t}\n\n// External package:\n\n\ttype MyAPIObject struct {\n\t\truntime.TypeMeta `json:\",inline\"`\n\t\tMyPlugin runtime.RawExtension `json:\"myPlugin\"`\n\t}\n\n\ttype PluginA struct {\n\t\tAOption string `json:\"aOption\"`\n\t}\n\n// On the wire, the JSON will look something like this:\n\n\t{\n\t\t\"kind\":\"MyAPIObject\",\n\t\t\"apiVersion\":\"v1\",\n\t\t\"myPlugin\": {\n\t\t\t\"kind\":\"PluginA\",\n\t\t\t\"aOption\":\"foo\",\n\t\t},\n\t}\n\nSo what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package's DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)",
    91            "type": "object",
    92        })
    93    }
    94}