1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
/// A struct that a patch can be applied to
///
/// Deriving [`Patch`] will generate a patch struct and an accompanying trait impl so that it can be applied to the original struct.
/// ```rust
/// # use struct_patch::Patch;
/// #[derive(Patch)]
/// struct Item {
/// field_bool: bool,
/// field_int: usize,
/// field_string: String,
/// }
///
/// // Generated struct
/// // struct ItemPatch {
/// // field_bool: Option<bool>,
/// // field_int: Option<usize>,
/// // field_string: Option<String>,
/// // }
/// ```
/// ## Container attributes
/// ### `#[patch_derive(...)]`
/// Use this attribute to derive traits on the generated patch struct
/// ```rust
/// # use struct_patch::Patch;
/// # use serde::{Serialize, Deserialize};
/// #[derive(Patch)]
/// #[patch_derive(Debug, Default, Deserialize, Serialize)]
/// struct Item;
///
/// // Generated struct
/// // #[derive(Debug, Default, Deserialize, Serialize)]
/// // struct ItemPatch {}
/// ```
///
/// ### `#[patch_name = "..."]`
/// Use this attribute to change the name of the generated patch struct
/// ```rust
/// # use struct_patch::Patch;
/// #[derive(Patch)]
/// #[patch_name = "ItemOverlay"]
/// struct Item { }
///
/// // Generated struct
/// // struct ItemOverlay {}
/// ```
///
/// ## Field attributes
/// ### `#[patch_skip]`
/// If you want certain fields to be unpatchable, you can let the derive macro skip certain fields when creating the patch struct
/// ```rust
/// # use struct_patch::Patch;
/// #[derive(Patch)]
/// struct Item {
/// #[patch_skip]
/// id: String,
/// data: String,
/// }
///
/// // Generated struct
/// // struct ItemPatch {
/// // data: Option<String>,
/// // }
/// ```
pub trait Patch<P> {
/// Apply a patch
fn apply(&mut self, patch: P);
/// Returns a patch that when applied turns any struct of the same type into `Self`
fn into_patch(self) -> P;
/// Returns a patch that when applied turns `previous_struct` into `Self`
fn into_patch_by_diff(self, previous_struct: Self) -> P;
/// Get an empty patch instance
fn new_empty_patch() -> P;
}
#[cfg(feature = "status")]
/// A patch struct with extra status information
pub trait PatchStatus {
/// Returns `true` if all fields are `None`, `false` otherwise.
fn is_empty(&self) -> bool;
}