Struct FileSeq

pub struct FileSeq { /* private fields */ }

Implementations

impl FileSeq

pub fn new<P: AsRef<Path>>(store_dir: P, initial_value: u64) -> Result<Self>

pub fn delete(&self)

Deletes this sequence

Once deleted, the sequence must be recreated

Example

use file_seq::FileSeq;
use std::path::Path;

let dir = Path::new("/tmp/example_delete");
let initial_value = 1;

let seq = FileSeq::new(&dir, initial_value).unwrap();

// Get current value
assert_eq!(initial_value, seq.value().unwrap());

seq.delete();

// Attempts to read the sequence after it's deleted returns an error
assert_eq!(seq.value().is_err(), true)

pub fn get_and_increment(&self, increment: u64) -> Result<u64>

Returns the current value of the sequence and then increments it.

Example

use file_seq::FileSeq;
use std::path::Path;

let dir = Path::new("/tmp/example_get_and_increment");
let initial_value = 1;

let seq = FileSeq::new(&dir, initial_value).unwrap();

assert_eq!(initial_value, seq.get_and_increment(1).unwrap());
assert_eq!(initial_value + 1, seq.value().unwrap());

pub fn increment_and_get(&self, increment: u64) -> Result<u64>

Increments the sequence and return the value.

Example

use file_seq::FileSeq;
use std::path::Path;

let dir = Path::new("/tmp/example_increment_and_get");
let initial_value = 1;

let seq = FileSeq::new(&dir, initial_value).unwrap();

assert_eq!(initial_value + 1, seq.increment_and_get(1).unwrap());
assert_eq!(initial_value + 1, seq.value().unwrap());

pub fn value(&self) -> Result<u64>

Returns the current value of the sequence.

Example

use file_seq::FileSeq;
use std::path::Path;

let dir = Path::new("/tmp/example_value");
let initial_value = 1;

let seq = FileSeq::new(&dir, initial_value).unwrap();

assert_eq!(initial_value, seq.value().unwrap());

Trait Implementations

impl Debug for FileSeq

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

Formats the value using the given formatter.