Enum Patch

#[non_exhaustive]
pub enum Patch<T: Serialize> {
    Apply(T),
    Json(Patch),
    Merge(T),
    Strategic(T),
}

Describes changes that should be applied to a resource

Takes arbitrary serializable data for all strategies except Json.

We recommend using (server-side) Apply patches on new kubernetes releases.

See kubernetes patch docs for the older patch types.

Note that patches have different effects on different fields depending on their merge strategies. These strategies are configurable when deriving your CustomResource.

Creating a patch via serde_json

use kube::api::Patch;
let patch = serde_json::json!({
    "apiVersion": "v1",
    "kind": "Pod",
    "metadata": {
        "name": "blog"
    },
    "spec": {
        "activeDeadlineSeconds": 5
    }
});
let patch = Patch::Apply(&patch);

Creating a patch from a type

use kube::api::Patch;
use k8s_openapi::api::rbac::v1::Role;
use k8s_openapi::apimachinery::pkg::apis::meta::v1::ObjectMeta;
let r = Role {
    metadata: ObjectMeta { name: Some("user".into()), ..ObjectMeta::default() },
    rules: Some(vec![])
};
let patch = Patch::Apply(&r);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Apply(T)

Server side apply

Requires kubernetes >= 1.16

Json(Patch)

Available on crate feature jsonpatch only.

JSON patch

Using this variant will require you to explicitly provide a type for T at the moment.

Example

use kube::api::Patch;
let json_patch = json_patch::Patch(vec![]);
let patch = Patch::Json::<()>(json_patch);

Merge(T)

JSON Merge patch

Strategic(T)

Strategic JSON Merge patch

Trait Implementations

impl<T: Clone + Serialize> Clone for Patch<T>

fn clone(&self) -> Patch<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Serialize> Debug for Patch<T>

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

Formats the value using the given formatter.

impl<T: PartialEq + Serialize> PartialEq for Patch<T>

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