reikland 0.1.3

A serde-compatible Ruby marshal parser and deserializer
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

use std::sync::Arc;

use num_bigint::BigInt;

use crate::{
    cursor::{
        object_table::{ObjectIdx, ObjectRefIdx},
        symbol_table::SymbolIdx,
    },
    marshal::MarshalData,
};

use super::string::RbStr;

/// A parsed Ruby marshal value.
///
/// Types reference children by [`ObjectIdx`] into the [`ObjectTable`][crate::cursor::object_table::ObjectTable].
/// Symbol references use [`SymbolIdx`] into the [`SymbolTable`][crate::cursor::symbol_table::SymbolTable].
#[derive(Debug, Clone, strum::IntoStaticStr)]
#[strum(serialize_all = "snake_case")]
pub enum MarshalValue<'a> {
    Nil,
    True,
    False,
    Fixnum(i32),
    Float(f64),
    Bignum(BigInt),
    SymbolLink(SymbolIdx),
    Symbol(&'a RbStr),
    String(&'a RbStr),
    Regex {
        pattern: &'a RbStr,
        flags: u8,
    },
    Array(Vec<ObjectIdx>),
    Hash(Vec<(ObjectIdx, ObjectIdx)>),
    HashDefault {
        pairs: Vec<(ObjectIdx, ObjectIdx)>,
        default: ObjectIdx,
    },
    ObjectRef(ObjectRefIdx),
    Object {
        class: SymbolIdx,
        ivars: Vec<(SymbolIdx, ObjectIdx)>,
    },
    Struct {
        name: SymbolIdx,
        members: Vec<(SymbolIdx, ObjectIdx)>,
    },
    Instance {
        inner: ObjectIdx,
        ivars: Vec<(SymbolIdx, ObjectIdx)>,
    },
    Extended {
        module: SymbolIdx,
        inner: ObjectIdx,
    },
    Class(&'a RbStr),
    Module(&'a RbStr),
    ClassOrModule(&'a RbStr),
    UserDefined {
        class: SymbolIdx,
        data: &'a [u8],
    },
    UserMarshal {
        class: SymbolIdx,
        inner: ObjectIdx,
    },
    UserString {
        class: SymbolIdx,
        inner: ObjectIdx,
    },
    Data {
        class: SymbolIdx,
        inner: ObjectIdx,
    },
}

impl<'a> MarshalValue<'a> {
    pub fn as_snake_case(&self) -> &'static str {
        self.into()
    }
}

impl<'a> TryFrom<MarshalData<'a>> for OwnedMarshalValue {
    type Error = ();
    fn try_from(_: MarshalData<'a>) -> Result<Self, Self::Error> {
        todo!()
    }
}

// todo: wire this up
#[allow(dead_code)]
#[derive(Debug, Clone)]
enum OwnedMarshalValue {
    Nil,
    True,
    False,
    Fixnum(i32),
    Float(f64),
    Bignum(BigInt),
    SymbolLink(Arc<[u8]>),
    Symbol(Arc<[u8]>),
    String(Arc<[u8]>),
    Regex {
        pattern: Arc<[u8]>,
        flags: u8,
    },
    Array(Vec<ObjectIdx>),
    Hash(Vec<(Arc<OwnedMarshalValue>, Arc<OwnedMarshalValue>)>),
    HashDefault {
        pairs: Vec<(Arc<OwnedMarshalValue>, Arc<OwnedMarshalValue>)>,
        default: Arc<OwnedMarshalValue>,
    },
    ObjectRef(Arc<OwnedMarshalValue>),
    Object {
        class: Arc<[u8]>,
        ivars: Vec<(Arc<[u8]>, Arc<OwnedMarshalValue>)>,
    },
    Struct {
        name: Arc<[u8]>,
        members: Vec<(Arc<[u8]>, Arc<OwnedMarshalValue>)>,
    },
    Instance {
        inner: Arc<OwnedMarshalValue>,
        ivars: Vec<(Arc<[u8]>, Arc<OwnedMarshalValue>)>,
    },
    Extended {
        module: Arc<[u8]>,
        inner: Arc<OwnedMarshalValue>,
    },
    Class(Arc<[u8]>),
    Module(Arc<[u8]>),
    ClassOrModule(Arc<[u8]>),
    UserDefined {
        class: Arc<[u8]>,
        data: Vec<u8>,
    },
    UserMarshal {
        class: Arc<[u8]>,
        inner: Arc<OwnedMarshalValue>,
    },
    UserString {
        class: Arc<[u8]>,
        inner: Arc<OwnedMarshalValue>,
    },
    Data {
        class: Arc<[u8]>,
        inner: Arc<OwnedMarshalValue>,
    },
}