nixl-sys 1.3.0

Low-level bindings to the nixl library
Documentation 
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

// SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

//! Synchronization manager for frontend-backend data consistency

use std::cell::Cell;

/// Trait for types that can synchronize their state to a backend
pub trait BackendSyncable {
    type Backend;
    type Error;
    fn sync_to_backend(&self, backend: &Self::Backend) -> Result<(), Self::Error>;
}

/// Manager that enforces correct synchronization between frontend and backend
pub struct SyncManager<T: BackendSyncable> {
    data: T,
    backend: T::Backend,
    dirty: Cell<bool>,
}

impl<T: BackendSyncable> SyncManager<T> {
    /// Creates a new sync manager (starts dirty to ensure first sync)
    pub fn new(data: T, backend: T::Backend) -> Self {
        Self {
            data,
            backend,
            dirty: Cell::new(true),
        }
    }

    /// Provides mutable access to the frontend data
    pub fn data_mut(&mut self) -> &mut T {
        self.dirty.set(true);
        &mut self.data
    }

    /// Provides read-only access to the frontend data (no sync)
    pub fn data(&self) -> &T {
        &self.data
    }

    /// Provides read-only access to the backend after ensuring synchronization
    pub fn backend(&self) -> Result<&T::Backend, T::Error> {
        self.ensure_synced()?;
        Ok(&self.backend)
    }

    fn ensure_synced(&self) -> Result<(), T::Error> {
        if self.dirty.get() {
            self.data.sync_to_backend(&self.backend)?;
            self.dirty.set(false);
        }
        Ok(())
    }
}