rsbx 2.0.0

Enhanced implementation of SeqBox in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

#![allow(dead_code)]
use general_error::Error;
use file_error::FileError;
use file_error::to_err;
use std::io::Read;
use std::io::Write;
use std::io::BufReader;
use std::io::SeekFrom;
use std::fs::File;
use std::io::Seek;
use std::fs::Metadata;
use std::fs::OpenOptions;

use reader::ReadResult;

const READ_RETRIES : usize = 5;

macro_rules! file_op {
    (
        $self:ident write => $input:expr
    ) => {{
        use self::FileHandle::*;
        match $self.file {
            Buffered(ref mut f)   => {
                // drop the internal buffer by seeking
                match f.seek(SeekFrom::Current(0)) {
                    Ok(_)  => {},
                    Err(e) => { return Err(to_err(FileError::new(e.kind(), &$self.path))); },
                }

                f.get_mut().write($input)
            },
            Unbuffered(ref mut f) => {
                f.write($input)
            },
        }
    }};
    (
        $self:ident $op:ident => $input:expr
    ) => {{
        use self::FileHandle::*;
        match $self.file {
            Buffered(ref mut f)   => f.$op($input),
            Unbuffered(ref mut f) => f.$op($input),
        }
    }};
    (
        $self:ident get_metadata
    ) => {{
        use self::FileHandle::*;
        match $self.file {
            Buffered(ref f)   => f.get_ref().metadata(),
            Unbuffered(ref f) => f.metadata(),
        }
    }}
}

pub struct FileReaderParam {
    pub write    : bool,
    pub buffered : bool,
}

enum FileHandle {
    Buffered(BufReader<File>),
    Unbuffered(File),
}

pub struct FileReader {
    file          : FileHandle,
    path          : String,
    write_enabled : bool,
}

impl FileReader {
    pub fn new(path  : &str,
               param : FileReaderParam) -> Result<FileReader, Error> {
        let write_enabled = param.write;
        let file =
            OpenOptions::new()
            .write(write_enabled)
            .read(true)
            .open(&path);
        let file = match file {
            Ok(f)  => f,
            Err(e) => { return Err(to_err(FileError::new(e.kind(), path))); }
        };
        Ok (FileReader {
            file :
            if param.buffered {
                FileHandle::Buffered(BufReader::new(file))
            } else {
                FileHandle::Unbuffered(file)
            },
            path : String::from(path),
            write_enabled,
        })
    }

    pub fn read(&mut self, buf : &mut [u8]) -> Result<ReadResult, Error> {
        let mut len_read = 0;
        let mut tries    = 0;
        while len_read < buf.len() && tries < READ_RETRIES {
            match file_op!(self read => &mut buf[len_read..]) {
                Ok(len) => { len_read += len; },
                Err(e)  => { return Err(to_err(FileError::new(e.kind(), &self.path))); }
            }

            tries += 1;
        }

        Ok(ReadResult { len_read,
                        eof_seen : len_read < buf.len() })
    }

    pub fn write(&mut self, buf : &[u8]) -> Result<usize, Error> {
        if !self.write_enabled {
            panic!("Write not enabled");
        }

        match file_op!(self write => buf) {
            Ok(len) => Ok(len),
            Err(e)  => Err(to_err(FileError::new(e.kind(), &self.path)))
        }
    }

    pub fn seek(&mut self, pos : SeekFrom)
                -> Result<u64, Error> {
        match file_op!(self seek => pos) {
            Ok(pos) => Ok(pos),
            Err(e)  => Err(to_err(FileError::new(e.kind(), &self.path)))
        }
    }

    pub fn cur_pos(&mut self) -> Result<u64, Error> {
        match file_op!(self seek => SeekFrom::Current(0)) {
            Ok(pos) => Ok(pos),
            Err(e)  => Err(to_err(FileError::new(e.kind(), &self.path)))
        }
    }

    pub fn metadata(&self) -> Result<Metadata, Error> {
        match file_op!(self get_metadata) {
            Ok(data) => Ok(data),
            Err(e)   => Err(to_err(FileError::new(e.kind(), &self.path)))
        }
    }

    pub fn get_file_size(&mut self) -> Result<u64, Error> {
        let cur_pos = self.cur_pos()?;

        let last_pos = self.seek(SeekFrom::End(0))?;

        self.seek(SeekFrom::Start(cur_pos))?;

        Ok(last_pos)
    }
}