limabean 0.4.1

Beancount frontend using Rust and Clojure and the Lima parser
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

use serde::{Deserialize, Serialize};
use std::borrow::Cow;

use crate::api::types::{SyntheticSpan, booked};

use super::types::{Plugin, Report, raw::*};

#[derive(Deserialize, Clone, Debug)]
#[serde(rename_all = "kebab-case")]
pub(crate) struct Request<'a> {
    pub(crate) jsonrpc: &'a str,
    pub(crate) id: Option<Id<'a>>,
    #[serde(borrow)]
    #[serde(flatten)]
    pub(crate) method: RequestMethod<'a>,
}

// TODO RequestMethod should be generic and the actual methods moved out of this module,
// but the deserialize lifetimes are a bit tricksy
#[derive(Deserialize, Clone, Debug)]
#[serde(tag = "method")]
#[serde(rename_all = "kebab-case")]
pub(crate) enum RequestMethod<'a> {
    Status,
    #[serde(rename = "parser.plugins")]
    ParserPlugins,
    #[serde(rename = "parser.directives")]
    ParserDirectives,
    #[serde(rename = "parser.options")]
    ParserOptions,
    #[serde(rename = "parser.format-errors")]
    ParserFormatErrors(Params<Vec<Report<'a>>>),
    #[serde(rename = "parser.format-warnings")]
    ParserFormatWarnings(Params<Vec<Report<'a>>>),
    #[serde(rename = "parser.resolve-span")]
    ParserResolveSpan(Params<Span>),
    #[serde(rename = "parser.create-synthetic-spans")]
    ParserCreateSyntheticSpans(Params<Vec<SyntheticSpan<'a>>>),
    #[serde(borrow)]
    Book(OptionalParams<Vec<Directive<'a>>>),
}

#[derive(Deserialize, Clone, Debug)]
#[serde(rename_all = "kebab-case")]
pub struct Params<T> {
    pub(crate) params: T,
}

#[derive(Deserialize, Clone, Debug)]
#[serde(rename_all = "kebab-case")]
pub struct OptionalParams<T> {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub(crate) params: Option<T>,
}

#[derive(Serialize, Clone, Debug)]
#[serde(rename_all = "kebab-case")]
pub(crate) struct ResultResponse<'i, 'a, 'b> {
    pub(crate) jsonrpc: &'static str,
    pub(crate) id: Option<Id<'i>>,
    pub(crate) result: ResultData<'a, 'b>,
}

impl<'i, 'a, 'b> ResultResponse<'i, 'a, 'b> {
    pub(crate) fn new(id: Option<Id<'i>>, result: ResultData<'a, 'b>) -> Self {
        ResultResponse {
            jsonrpc: JSONRPC_VERSION,
            id,
            result,
        }
    }
}

#[derive(Serialize, Clone, Debug)]
#[serde(rename_all = "kebab-case")]
#[serde(untagged)]
pub(crate) enum ResultData<'a, 'b> {
    Ok,
    Plugins(&'b [Plugin<'a>]),
    #[serde(borrow)]
    RawDirectives(RawDirectives<'a>),
    Options(&'b Options<'a>),
    Report(Cow<'b, str>),
    ResolvedSpan(SpannedSource<'a>),
    Spans(Vec<Span>),
    // TODO also return warnings with booked
    BookedDirectives(BookedDirectives<'a>),
}

#[derive(Serialize, Clone, Debug)]
#[serde(rename_all = "kebab-case")]
pub(crate) struct RawDirectives<'a> {
    pub(crate) directives: Vec<Directive<'a>>,
    pub(crate) warnings: Option<Vec<Report<'a>>>,
}

#[derive(Serialize, Clone, Debug)]
#[serde(rename_all = "kebab-case")]
pub(crate) struct BookedDirectives<'a> {
    pub(crate) directives: Vec<booked::Directive<'a>>,
}

#[derive(Serialize, Clone, Debug)]
#[serde(rename_all = "kebab-case")]
pub(crate) struct ErrorResponse<'a, 'b, T>
where
    T: Serialize,
{
    pub(crate) jsonrpc: &'static str,
    pub(crate) id: Option<Id<'a>>,
    pub(crate) error: ErrorData<'b, T>,
}

impl<'a, 'b, T> ErrorResponse<'a, 'b, T>
where
    T: Serialize,
{
    pub(crate) fn new(
        id: Option<Id<'a>>,
        code: ErrorCode,
        message: Cow<'b, str>,
        data: Option<T>,
    ) -> Self {
        ErrorResponse {
            jsonrpc: JSONRPC_VERSION,
            id,
            error: ErrorData {
                code,
                message,
                data,
            },
        }
    }
}

#[derive(Serialize, Clone, Debug)]
pub(crate) struct ErrorData<'a, T>
where
    T: Serialize,
{
    code: i32,
    message: Cow<'a, str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    data: Option<T>,
}

#[derive(Serialize, Deserialize, Copy, Clone, Debug)]
#[serde(untagged)]
pub(crate) enum Id<'a> {
    String(&'a str),
    Int(i32),
    Float(f64),
}

pub(crate) const JSONRPC_VERSION: &str = "2.0";

// https://www.jsonrpc.org/specification#error_object
pub(crate) type ErrorCode = i32;
pub(crate) const ERROR_BEANFILE_IO_ERROR: ErrorCode = 1;
pub(crate) const ERROR_REPORT: ErrorCode = 2;
pub(crate) const ERROR_INDEXED_REPORT: ErrorCode = 3;
pub(crate) const ERROR_PARSE: ErrorCode = -32700;
pub(crate) const ERROR_INVALID_REQUEST: ErrorCode = -32600;
pub(crate) const ERROR_INTERNAL: ErrorCode = -32603;