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

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

use alloc::vec::Vec;
use core::marker::Sized;

use crate::prelude::*;

pub trait Encode {
    fn encode<E>(&self, encoder: E) -> E::Ok
    where
        E: Encoder;
}

pub trait EncodeSequence {
    type Ok;

    fn encode_element<T: Sized>(&mut self, value: &T)
    where
        T: Encode;

    fn end(self) -> Self::Ok;
}

pub trait Encoder: Sized {
    type Ok;
    type EncodeSequence: EncodeSequence<Ok = Self::Ok>;

    fn to_vec<Op, Val>(input: &Script<Op, Val>) -> Vec<u8>
    where
        Op: core::fmt::Debug + Encode,
        Val: core::fmt::Debug + Encode;

    fn write_u8(self, input: u8) -> Self::Ok;
    fn write_bytes(self, input: &[u8]) -> Self::Ok;

    fn encode_item<Op, Val>(self, input: &Item<Op, Val>) -> Self::Ok
    where
        Op: core::fmt::Debug + Encode,
        Val: core::fmt::Debug + Encode;
    fn encode_seq(self) -> Self::EncodeSequence;
}