Struct acidjson::AcidJson

source ·
pub struct AcidJson<T: Serialize + DeserializeOwned + Sync> { /* private fields */ }
Expand description

A “smart pointer” to a JSON file on disk. Can be used in a RwLock-like fashion for thread-safe, ACID-guaranteed updates to the underlying file. Is “Arc-like” can can be cheaply cloned to create more references to the same file.

Implementations§

source§

impl<T: Serialize + DeserializeOwned + Sync> AcidJson<T>

source

pub fn open(fname: &Path) -> Result<Self, AcidJsonError>

Opens an AcidJson.

source

pub fn open_or_else( fname: &Path, gen_def: impl FnOnce() -> T ) -> Result<Self, AcidJsonError>

Opens an AcidJson, with a default value if the file does not yet exist.

source

pub fn read(&self) -> AcidJsonReadGuard<'_, T>

Read-locks the AcidJson.

source

pub fn write(&self) -> AcidJsonWriteGuard<'_, T>

Write-locks the AcidJson.

Trait Implementations§

source§

impl<T: Clone + Serialize + DeserializeOwned + Sync> Clone for AcidJson<T>

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T: Debug + Serialize + DeserializeOwned + Sync> Debug for AcidJson<T>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for AcidJson<T>

§

impl<T> Send for AcidJson<T>where T: Send,

§

impl<T> Sync for AcidJson<T>where T: Send,

§

impl<T> Unpin for AcidJson<T>

§

impl<T> UnwindSafe for AcidJson<T>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. 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 Twhere 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 Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.