Struct bi::FileBi

pub struct FileBi<'a> { /* fields omitted */ }

File Bi

Helps reading/writing files synchronously.

Examples

use std::{
    path::PathBuf,
    sync::Arc,
    thread,
    time::Duration,
};

use bi::{Bi, FileBi};

let max_buf_size = 1024 * 1024;
let delay = Duration::from_millis(100);
let timeout = 30;
let file_bi = Arc::new(FileBi::new(max_buf_size, Some(delay), Some(timeout)));

let job = {
    let file_bi = file_bi.clone();
    thread::spawn(move || {
        let file = &PathBuf::from(file!()).canonicalize().unwrap();
        let (id, bytes) = file_bi.read(file).unwrap();
        assert_eq!(file_bi.buf_size(), bytes.len() as u64);
        file_bi.release_read(id).unwrap();
        file_bi.release_read(id).unwrap_err();
    })
};
job.join().unwrap();

assert_eq!(file_bi.buf_size(), 0);

Methods

impl<'_> FileBi<'_>

pub const DEFAULT_DELAY: Duration

Defautl delay

pub const DEFAULT_TIMEOUT: u64

Defautl timeout, in seconds

pub fn new(
    max_buf_size: u64,
    delay: Option<Duration>,
    timeout: Option<u64>
) -> Self

Makes new instance

• Delay and timeout are only used for reads. Timeout is in seconds. When buf size reaches max buf size, next reads will have to wait for your processing code. When you finish handling your data, even if you call ::drop() on it, you still have to call ::release_read(). Otherwise you won't be able to read next files.
• Reads/writes use same lock.

Trait Implementations

impl<'a> Bi for FileBi<'a>

type Resource = &'a Path

Resource

fn max_buf_size(&self) -> u64

Gets max buf size

fn buf_size(&self) -> u64

Gets current buf size

fn read(&self, file: Self::Resource) -> Result<(usize, Vec<u8>)>

Reads

fn read_to_string(&self, file: Self::Resource) -> Result<(usize, String)>

Reads to string

fn release_read(&self, id: usize) -> Result<()>

Releases what has been read

fn write<B: AsRef<[u8]>>(&self, bytes: B, file: Self::Resource) -> Result<()>

Writes

impl<'a> Debug for FileBi<'a>

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

Formats the value using the given formatter.