crain 0.1.0

A Brainfuck compiler/interpreter/tool
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

/// The cell of the Brainfuck virtual machine.
///
/// Any type that acts as the cell for the Brainfuck virtual machine
/// must implement this trait.
/// This trait defines the atomic operations required for the Brainfuck virtual machine
/// to interact with the cell.
pub trait BfCell: Clone + Copy + Eq + PartialEq {
    /// Zero of the type.
    const ZERO: Self;
    /// One of the type.
    const ONE: Self;

    /// Increases `self` by the given value.
    ///
    /// This will modify `self` in place and does not return a value.
    fn add(&mut self, rhs: Self);
    /// Decreases `self` by the given value.
    ///
    /// This will modify `self` in place and does not return a value.
    fn sub(&mut self, rhs: Self);

    /// Returns true if `self` is zero.
    fn iszero(self) -> bool;

    /// Reads bytes of the same length as `self` from the input stream and writes them into `self`.
    ///
    /// # Failures
    /// A `std::io::Error` will be returned if it occurs during the reading process.
    fn input(&mut self, bfinput: &mut impl std::io::Read) -> Result<(), std::io::Error>;
    /// Writes `self` to the output stream.
    ///
    /// # Failures
    /// A `std::io::Error` will be returned if it occurs during the writing process.
    fn output(self, bfoutput: &mut impl std::io::Write) -> Result<(), std::io::Error>;
}