Skip to main content

VecSidecar

Struct VecSidecar 

Source
pub struct VecSidecar<T> { /* private fields */ }
Expand description

Atomic JSON sidecar specialized to a Vec<T> document — the shape every _system/ row table uses (CDC checkpoints, scheduler jobs, deferred triggers, declared plugins).

Wraps SystemSidecar and adds the two conveniences every row-table caller re-rolled by hand: Self::load returns an empty Vec for an absent / empty file, and Self::store takes a borrowed &[T] so a caller that already owns a Vec<T> (or a sub-slice) persists it without an intermediate clone.

Implementations§

Source§

impl<T> VecSidecar<T>

Source

pub fn new(data_path: impl AsRef<Path>, file_name: &str) -> Self

Construct rooted at <data_path>/_system/<file_name>.

file_name must match the on-disk name the subsystem has always used — changing it would orphan existing state across an upgrade.

Source

pub fn path(&self) -> &Path

Borrow the resolved sidecar path (for diagnostics).

Source

pub fn load(&self) -> Result<Vec<T>, SidecarIoError>

Load the persisted rows, or an empty Vec if the file is absent or empty.

§Errors

Returns SidecarIoError::Read on IO failure or SidecarIoError::Decode when the file is present but not valid JSON.

Source

pub fn store(&self, rows: &[T]) -> Result<(), SidecarIoError>
where T: Serialize,

Atomically replace the persisted rows with rows.

Takes a borrowed slice so callers that already own a Vec<T> persist it without cloning.

§Errors

Same as SystemSidecar::store.

Trait Implementations§

Source§

impl<T: Clone> Clone for VecSidecar<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for VecSidecar<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for VecSidecar<T>

§

impl<T> RefUnwindSafe for VecSidecar<T>

§

impl<T> Send for VecSidecar<T>

§

impl<T> Sync for VecSidecar<T>

§

impl<T> Unpin for VecSidecar<T>

§

impl<T> UnsafeUnpin for VecSidecar<T>

§

impl<T> UnwindSafe for VecSidecar<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.