byte-slice 0.1.11

Byte slice manipulation macros
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

// +-----------------------------------------------------------------------------------------------+
// | Copyright 2016 Sean Kerr                                                                      |
// |                                                                                               |
// | Licensed under the Apache License, Version 2.0 (the "License");                               |
// | you may not use this file except in compliance with the License.                              |
// | You may obtain a copy of the License at                                                       |
// |                                                                                               |
// |  http://www.apache.org/licenses/LICENSE-2.0                                                   |
// |                                                                                               |
// | Unless required by applicable law or agreed to in writing, software                           |
// | distributed under the License is distributed on an "AS IS" BASIS,                             |
// | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.                      |
// | See the License for the specific language governing permissions and                           |
// | limitations under the License.                                                                |
// +-----------------------------------------------------------------------------------------------+
// | Author: Sean Kerr <sean@code-box.org>                                                         |
// +-----------------------------------------------------------------------------------------------+

#[macro_use]
pub mod macros;

#[cfg(test)]
mod test;

use std::fmt;

/// Default byte stream type.
///
/// All stream macros will accept any struct given as `$context`, as long as they contain the
/// following four fields:
///
/// - `byte` (u8) The most recent byte.
/// - `mark_index` (usize) Starting index of a collection of marked bytes.
/// - `stream` (&[u8]) Stream of bytes.
/// - `stream_index` (usize) Current stream index.
pub struct ByteStream<'a> {
    /// Current byte.
    pub byte: u8,

    /// Callback mark index.
    pub mark_index: usize,

    /// Stream data.
    pub stream: &'a [u8],

    /// Stream index.
    pub stream_index: usize
}

impl<'a> ByteStream<'a> {
    /// Create a new `ByteStream`.
    pub fn new(stream: &'a [u8]) -> ByteStream<'a> {
        ByteStream{ byte:         0,
                 mark_index:   0,
                 stream:       stream,
                 stream_index: 0 }
    }
}

impl<'a> fmt::Debug for ByteStream<'a> {
    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        if is_visible_8bit!(self.byte) || self.byte == 0x20 || self.byte == 0xFF {
            write!(formatter, "ByteStream(byte[{}]='{}', mark_index={}, stream_index={})",
                   self.byte, self.byte as char, self.mark_index, self.stream_index)
        } else {
            write!(formatter, "ByteStream(byte[{}]='', mark_index={}, stream_index={})",
                   self.byte, self.mark_index, self.stream_index)
        }
    }
}

impl<'a> fmt::Display for ByteStream<'a> {
    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        if is_visible_8bit!(self.byte) || self.byte == 0x20 || self.byte == 0xFF {
            write!(formatter, "byte[{}]='{}', mark_index={}, stream_index={}",
                   self.byte, self.byte as char, self.mark_index, self.stream_index)
        } else {
            write!(formatter, "byte[{}]='', mark_index={}, stream_index={}",
                   self.byte, self.mark_index, self.stream_index)
        }
    }
}