Struct TrackedResource

Source

pub struct TrackedResource<T> { /* private fields */ }

Expand description

A wrapper that tracks changes to a resource.

TrackedResource<T> stores both the current resource data and its original state (as JSON). This allows detecting which fields have changed since the resource was loaded or last saved.

§Type Parameters

T - The resource type. Must implement Serialize, DeserializeOwned, and Clone for state tracking to work.

§Deref Pattern

Implements Deref<Target = T> and DerefMut, so you can access and modify the resource transparently:

use shopify_sdk::rest::TrackedResource;
use serde::{Serialize, Deserialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
struct Product { title: String }

let mut tracked = TrackedResource::new(Product { title: "Test".to_string() });

// Read via Deref
println!("{}", tracked.title);

// Write via DerefMut
tracked.title = "Modified".to_string();

Implementations§

Source §

impl<T: Serialize + DeserializeOwned + Clone> TrackedResource<T>

Source

pub const fn new(resource: T) -> Self

Creates a new tracked resource for a resource that doesn’t exist yet.

New resources have no original state, so is_dirty() returns true and changed_fields() returns all fields.

§Example

use shopify_sdk::rest::TrackedResource;
use serde::{Serialize, Deserialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
struct Product { title: String }

let tracked = TrackedResource::new(Product { title: "New".to_string() });
assert!(tracked.is_dirty()); // New resources are always dirty

Source

pub fn from_existing(resource: T) -> Self

Creates a tracked resource from an existing resource.

The current state is captured as the original state, so is_dirty() returns false until the resource is modified.

§Example

use shopify_sdk::rest::TrackedResource;
use serde::{Serialize, Deserialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
struct Product { title: String }

let tracked = TrackedResource::from_existing(Product { title: "Loaded".to_string() });
assert!(!tracked.is_dirty()); // Existing resources start clean

Source

pub fn is_dirty(&self) -> bool

Returns true if the resource has been modified since loading or last save.

For new resources (no original state), always returns true.

§Example

use shopify_sdk::rest::TrackedResource;
use serde::{Serialize, Deserialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
struct Product { title: String }

let mut tracked = TrackedResource::from_existing(Product { title: "Test".to_string() });
assert!(!tracked.is_dirty());

tracked.title = "Changed".to_string();
assert!(tracked.is_dirty());

Source

pub fn changed_fields(&self) -> Value

Returns only the fields that have changed since loading or last save.

For new resources, returns all fields (since there’s no original state to compare against).

For existing resources, returns only the fields whose values differ from the original state. Nested objects are handled recursively.

§Example

use shopify_sdk::rest::TrackedResource;
use serde::{Serialize, Deserialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
struct Product { title: String, vendor: String }

let mut tracked = TrackedResource::from_existing(Product {
    title: "Original".to_string(),
    vendor: "Vendor".to_string(),
});

tracked.title = "Changed".to_string();

let changes = tracked.changed_fields();
assert!(changes.get("title").is_some());
assert!(changes.get("vendor").is_none()); // Unchanged

Source

pub fn mark_clean(&mut self)

Marks the resource as clean by capturing the current state as original.

Call this after a successful save operation to reset dirty tracking.

§Example

use shopify_sdk::rest::TrackedResource;
use serde::{Serialize, Deserialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
struct Product { title: String }

let mut tracked = TrackedResource::from_existing(Product { title: "Test".to_string() });
tracked.title = "Changed".to_string();
assert!(tracked.is_dirty());

tracked.mark_clean();
assert!(!tracked.is_dirty());

Source