scriptful 0.4.0

A minimalist, `no_std` stack machine library for interpreting domain specific interpreted languages.
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

//! Traits for decoding of scripts, operators and values.
//!
//! These are modeled after `serde`'s `Deserializer` and `Deserialize` traits.
//!
//! - `Decoder` shall be implemented by different encoding and decoding mechanisms (aka **codecs**).
//! - `Decode` shall be implemented for every data structure that can be decoded using any codec.

use alloc::string::String;
use alloc::vec::Vec;

use crate::prelude::*;

pub trait Decoder: Sized {
    type Error: Error;

    fn decode_i128(&mut self) -> Result<i128, Self::Error>;

    fn decode_f64(&mut self) -> Result<f64, Self::Error>;

    fn decode_string(&mut self) -> Result<String, Self::Error>;

    fn decode_item<Op, Val>(&mut self) -> Result<Item<Op, Val>, Self::Error>
    where
        Op: core::fmt::Debug + Decode,
        Val: core::fmt::Debug + Decode;

    fn decode_script<Op, Val>(&mut self) -> Result<Script<Op, Val>, Self::Error>
    where
        Op: core::fmt::Debug + Decode,
        Val: core::fmt::Debug + Decode;

    fn from_vec<Op, Val>(input: Vec<u8>) -> Result<Script<Op, Val>, Self::Error>
    where
        Op: core::fmt::Debug + Decode,
        Val: core::fmt::Debug + Decode;

    fn peek_byte(&self) -> Result<&u8, Self::Error>;

    fn read_byte(&mut self) -> Result<u8, Self::Error>;

    fn read_bytes(&mut self, length: usize) -> Result<&[u8], Self::Error>;
}

pub trait Decode: Sized {
    fn decode<D>(decoder: &mut D) -> Result<Self, D::Error>
    where
        D: Decoder;
}