Struct diskit::log_diskit::LogDiskit

pub struct LogDiskit<D>
where
    D: Diskit,
{
    pub inner: D,
    pub log: Arc<Mutex<LogFunc>>,
}

Logging diskit

This diskit extensively logs all requests it gets and passes them to an other diskit (like StdDiskit or VirtualDiskit) to satisfy.

Every request is logged before an operation is performed and after – in a style depending on whether it was successful or not – it completed by passing a String to the logging function (the default logging function prints them to stdout).

use diskit::{diskit_extend::DiskitExt, log_diskit, LogDiskit, VirtualDiskit};
use std::{
    io::Write,
    sync::{Arc, Mutex},
};

let output = Arc::new(Mutex::new(String::new()));
let diskit = LogDiskit::new(
    VirtualDiskit::default(),
    log_diskit::get_log_in_buf_func(output.clone()),
);

let mut file = diskit.create("test.txt")?;
file.write_all(b"Hello, World!")?;

file.close()?;

assert_eq!(*output.lock().unwrap(),
    "Creating \"test.txt\".
Created \"test.txt\": FileInner { file: None, val: 0 }.
Writing all of [72, 101, 108, 108, 111, 44, 32, 87, 111, 114, 108, 100, 33] into FileInner { file: None, val: 0 }.
Wrote all of [72, 101, 108, 108, 111, 44, 32, 87, 111, 114, 108, 100, 33] in FileInner { file: None, val: 0 }.
Closing FileInner { file: None, val: 0 }.
Closed a file.
");

You can write your own logging function or use one of the two predefined ones: get_standard_log_func and get_log_in_buf_func.

Fields

inner: D

log: Arc<Mutex<LogFunc>>

Implementations

impl<D> LogDiskit<D>

where D: Diskit,

pub fn new(inner: D, log: LogFunc) -> Self

Creates a new custom LogDiskit

Creates a new LogDiskit with the given inner diskit and logging function.

pub fn new_raw(inner: D, log: Arc<Mutex<LogFunc>>) -> Self

Creates a new custom LogDiskit with a reference to a logging function

Creates a new LogDiskit with the given inner diskit and an Arc<Mutex<_>> of the logging function. This is useful if you want to share one function between two LogDiskits.

pub fn set_log_func(&mut self, log: LogFunc)

Sets the logging function

Changes the logging function to the provided one.

pub fn set_log_func_raw(&mut self, log: Arc<Mutex<LogFunc>>)

Sets the logging function with a reference to a logging function

Changes the logging function to the provided one allowing to share one function between multiple LogDiskits.

Trait Implementations

impl<D> Clone for LogDiskit<D>

where D: Diskit + Clone,

fn clone(&self) -> LogDiskit<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D> Default for LogDiskit<D>

where D: Diskit,

fn default() -> Self

Returns the “default value” for a type.

impl<D> Diskit for LogDiskit<D>

where D: Diskit,

fn set_pwd_inner(&self, path: &Path) -> Result<(), Error>

Changes the current working directory

fn get_pwd(&self) -> Result<PathBuf, Error>

Retrieves the current working directory

fn open_inner(&self, path: &Path) -> Result<File<Self>, Error>

Opens an exisitent file

fn create_inner(&self, path: &Path) -> Result<File<Self>, Error>

Creates a new file or truncates it

fn open_with_options_inner( &self, path: &Path, options: OpenOptions ) -> Result<File<Self>, Error>

Opens a file with custom options

fn read_inner(&self, file: &FileInner, buf: &mut [u8]) -> Result<usize, Error>

Reads as much as possible into the provided buffer

fn read_to_end_inner( &self, file: &mut FileInner, buf: &mut Vec<u8> ) -> Result<usize, Error>

Reads the complete file into the provided buffer

fn read_to_string_inner( &self, file: &mut FileInner, buf: &mut String ) -> Result<usize, Error>

Reads the complete file into the provided string

fn write_inner(&self, file: &mut FileInner, buf: &[u8]) -> Result<usize, Error>

Writes as much as possible from the provided buffer

fn write_all_inner(&self, file: &mut FileInner, buf: &[u8]) -> Result<(), Error>

Writes the complete provided buufer into the file

fn flush_inner(&self, file: &mut FileInner) -> Result<(), Error>

Flushes all writes of the file

fn metadata_inner(&self, file: &FileInner) -> Result<Metadata, Error>

Retrieves the metadata of the file

fn seek_inner(&self, file: &mut FileInner, pos: SeekFrom) -> Result<u64, Error>

Repositions the file’s cursor

fn create_dir_inner(&self, path: &Path) -> Result<(), Error>

Creates a directory

fn create_dir_all_inner(&self, path: &Path) -> Result<(), Error>

Creates a directory and all above if necessary

fn close_inner(&self, file: FileInner) -> Result<(), Error>

Closes the file

fn walkdir_inner(&self, path: &Path) -> WalkDir<Self>

Creates a Walkdir from a path

fn into_walkdir_iterator(&self, walkdir: WalkDir<Self>) -> WalkdirIterator<Self>

Converts a walkdir builder to an iterator

fn walkdir_next_inner( &self, inner: &mut WalkdirIteratorInner ) -> Option<Result<DirEntry, Error>>

Gets the next file in a WalkDir