Struct VowBuilder 

pub struct VowBuilder<T, F, A, Fo> { /* private fields */ }

Builder for Vow.

By default, it will:

• use JSON format without pretty printing.
• not overwrite the file if it already exists and has valid content.
• not fail on (deny) invalid content (instead, overwrite it silently).

It is usually recommended to use Vow::builder or Vow::open and its async counterparts to create a new builder.

Example

use vow::VowBuilder;
use serde::{Deserialize, Serialize};
use std::fs::File;

#[derive(Serialize, Deserialize)]
struct Data {
   value: i32,
}

let file = File::create("data.json").unwrap();
let vow = VowBuilder::new(file)
    .json()
    .pretty()
    .default(Data { value: 42 })
    .deny_invalid()
    .overwrite_local()
    .build();

Implementations

impl<T, F> VowBuilder<Nothing<T>, F, Blocking, Json>

pub const fn new(file: F) -> Self

Create a new blocking builder.

pub fn open(path: impl AsRef<Path>) -> Self

Open a blocking file at the given path.

impl<T, F> VowBuilder<Nothing<T>, F, Async, Json>

pub const fn new(file: F) -> Self

Create a new async builder.

pub fn open(path: impl AsRef<Path>) -> Self

Open a blocking file at the given path.

impl<T, F, A, Fo> VowBuilder<Nothing<T>, F, A, Fo>

pub fn with_type<U>(self) -> VowBuilder<Nothing<U>, F, A, Fo>

Set the type of the value without providing anything concrete.

This is useful when you know there’s existsing value stored in file and its type, so we can just retrieve it during initialization.

pub fn default<U>(self, value: U) -> VowBuilder<Just<U>, F, A, Fo>

Set the default value in case the file is empty or has invalid content.

impl<T, F, A, Fo> VowBuilder<T, F, A, Fo>

pub const fn deny_invalid(self) -> Self

When set true, Vow will fail to build if the file already exists and has invalid content.

pub const fn overwrite_local(self) -> Self

Overwrite the file no matter whether it already exists or if it has valid content

pub const fn keep_local(self) -> Self

Keep the file content unless it doesn’t exist or contains invalid content

impl<T, F, A, Fo> VowBuilder<T, F, A, Fo>

pub fn json(self, pretty: bool) -> VowBuilder<T, F, A, Json>

Available on crate feature format-json only.

Output the data in JSON format.

impl<T, F, A, Fo> VowBuilder<T, F, A, Fo>

pub fn toml(self) -> VowBuilder<T, F, A, Toml>

Available on crate feature format-toml only.

Output the data in JSON format.

impl<T, F, Fo> VowBuilder<T, F, Async, Fo>

where T: ToOption, F: VowFileAsync, T::Some: Serialize + DeserializeOwned, Fo: ToFormat,

pub async fn build(self) -> VowResult<VowAsync<T::Some, F>>

Build the VowAsync instance.

impl<T, F, Fo> VowBuilder<T, F, Blocking, Fo>

where T: ToOption, F: VowFile, T::Some: Serialize + DeserializeOwned, Fo: ToFormat,

pub fn build(self) -> VowResult<Vow<T::Some, F>>

Build the Vow instance.