dusk-cdf 0.5.0

PLONK debugger CDF implementation
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175

use std::{io, mem};

use crate::{
    Config, DecodableElement, DecoderContext, Element, EncodableElement, EncoderContext, Preamble,
};

#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub(crate) struct EncodedSource {
    pub(crate) line: u64,
    pub(crate) col: u64,
    pub(crate) contents_index: usize,
}

impl EncodedSource {
    const fn new(line: u64, col: u64, contents_index: usize) -> Self {
        Self {
            line,
            col,
            contents_index,
        }
    }
}

impl Element for EncodedSource {
    fn len(ctx: &Config) -> usize {
        2 * u64::len(ctx) + usize::len(ctx)
    }

    fn validate(&self, preamble: &Preamble) -> io::Result<()> {
        self.line.validate(preamble)?;
        self.col.validate(preamble)?;
        self.contents_index.validate(preamble)?;

        Ok(())
    }
}

impl EncodableElement for EncodedSource {
    fn to_buffer(&self, ctx: &mut EncoderContext, buf: &mut [u8]) {
        let buf = self.line.encode(ctx, buf);
        let buf = self.col.encode(ctx, buf);
        let _ = self.contents_index.encode(ctx, buf);
    }
}

impl DecodableElement for EncodedSource {
    fn try_from_buffer_in_place<'b>(
        &mut self,
        ctx: &DecoderContext,
        buf: &'b [u8],
    ) -> io::Result<()> {
        Self::validate_buffer(ctx.config(), buf)?;

        let buf = self.line.try_decode_in_place(ctx, buf)?;
        let buf = self.col.try_decode_in_place(ctx, buf)?;
        let _ = self.contents_index.try_decode_in_place(ctx, buf)?;

        Ok(())
    }
}

/// Source file tripler that can be encoded into a CDF file
#[derive(Debug, Default, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct EncodableSource {
    line: u64,
    col: u64,
    path: String,
}

impl EncodableSource {
    /// Create a new source instance
    pub const fn new(line: u64, col: u64, path: String) -> Self {
        Self { line, col, path }
    }

    /// Source line
    pub const fn line(&self) -> u64 {
        self.line
    }

    /// Source column
    pub const fn col(&self) -> u64 {
        self.col
    }

    /// Path to be encoded
    pub fn path(&self) -> &str {
        &self.path
    }
}

impl Element for EncodableSource {
    fn len(ctx: &Config) -> usize {
        EncodedSource::len(ctx)
    }

    fn validate(&self, preamble: &Preamble) -> io::Result<()> {
        self.line.validate(preamble)?;
        self.col.validate(preamble)?;

        Ok(())
    }
}

impl EncodableElement for EncodableSource {
    fn to_buffer(&self, ctx: &mut EncoderContext, buf: &mut [u8]) {
        let contents_index = ctx.add_path(self.path.clone());
        let encodable = EncodedSource::new(self.line, self.col, contents_index);

        encodable.to_buffer(ctx, buf)
    }
}

/// Source file decoded from a CDF file
#[derive(Debug, Default, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct DecodedSource<'a> {
    pub(crate) line: u64,
    pub(crate) col: u64,
    pub(crate) name: &'a str,
    pub(crate) contents: &'a str,
}

impl<'a> Element for DecodedSource<'a> {
    fn len(ctx: &Config) -> usize {
        EncodedSource::len(ctx)
    }

    fn validate(&self, preamble: &Preamble) -> io::Result<()> {
        self.line.validate(preamble)?;
        self.col.validate(preamble)?;

        Ok(())
    }
}

impl<'a> DecodableElement for DecodedSource<'a> {
    fn try_from_buffer_in_place<'x, 'b>(
        &'x mut self,
        ctx: &DecoderContext<'x>,
        buf: &'b [u8],
    ) -> io::Result<()> {
        let (encoded, _) = EncodedSource::try_decode(ctx, buf)?;
        let EncodedSource {
            line,
            col,
            contents_index,
        } = encoded;

        let name = ctx.fetch_name(contents_index).ok_or_else(|| {
            io::Error::new(
                io::ErrorKind::Other,
                "the source name wasn't available in the file cache",
            )
        })?;

        let contents = ctx.fetch_contents(contents_index).ok_or_else(|| {
            io::Error::new(
                io::ErrorKind::Other,
                "the source contents wasn't available in the file cache",
            )
        })?;

        self.line = line;
        self.col = col;

        // the compiler isn't smart enough here to understand that `self` is `'a`; hence the
        // context is also `'a`
        //
        // it is desirable to perform this safe change instead of taking every source as owned
        self.name = unsafe { mem::transmute::<&'x str, &'a str>(name) };
        self.contents = unsafe { mem::transmute::<&'x str, &'a str>(contents) };

        Ok(())
    }
}