debug-adapter-protocol 0.1.0

A Rust implementation of the Debug Adapter Protocol
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
use crate::{
    types::{
        Breakpoint, BreakpointLocation, Capabilities, CompletionItem, DataBreakpointAccessType,
        DisassembledInstruction, ExceptionBreakMode, ExceptionDetails, GotoTarget, Message, Module,
        Scope, Source, StackFrame, StepInTarget, Thread, Variable, VariablePresentationHint,
    },
    utils::{eq_default, true_},
    ProtocolMessageContent, SequenceNumber,
};
use serde::{
    de::{Error, Unexpected},
    Deserialize, Deserializer, Serialize, Serializer,
};
use serde_json::{Number, Value};
use typed_builder::TypedBuilder;

/// Response for a request.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct Response {
    /// Sequence number of the corresponding request.
    pub request_seq: SequenceNumber,

    #[serde(
        flatten,
        deserialize_with = "deserialize_response_result",
        serialize_with = "serialize_response_result"
    )]
    pub result: Result<SuccessResponse, ErrorResponse>,
}
impl From<Response> for ProtocolMessageContent {
    fn from(response: Response) -> Self {
        Self::Response(response)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct ErrorResponse {
    /// The command requested.
    pub command: String,

    /// Contains the raw error in short form if 'success' is false.
    /// This raw error might be interpreted by the frontend and is not shown in the
    /// UI.
    /// Some predefined values exist.
    /// Values:
    /// 'cancelled': request was cancelled.
    /// etc.
    pub message: String,

    #[builder(default)]
    pub body: ErrorResponseBody,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct ErrorResponseBody {
    /// An optional, structured error message.
    pub error: Option<Message>,

    #[serde(skip)]
    private: (),
}
impl ErrorResponseBody {
    pub fn new(error: Option<Message>) -> Self {
        Self { error, private: () }
    }
}
impl Default for ErrorResponseBody {
    fn default() -> Self {
        ErrorResponseBody::new(None)
    }
}

/// Contains request result if success is true and optional error details if success is false.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "camelCase", tag = "command", content = "body")]
pub enum SuccessResponse {
    /// Response to 'attach' request. This is just an acknowledgement, so no body field is required.
    Attach,

    /// Response to 'breakpointLocations' request.
    ///
    /// Contains possible locations for source breakpoints.
    BreakpointLocations(BreakpointLocationsResponseBody),

    /// Response to 'cancel' request. This is just an acknowledgement, so no body field is required.
    Cancel,

    /// Response to 'completions' request.
    Completions(CompletionsResponseBody),

    /// Response to 'configurationDone' request. This is just an acknowledgement, so no body field is required.
    ConfigurationDone,

    /// Response to 'continue' request.
    Continue(ContinueResponseBody),

    /// Response to 'dataBreakpointInfo' request.
    DataBreakpointInfo(DataBreakpointInfoResponseBody),

    /// Response to 'disassemble' request.
    Disassemble(DisassembleResponseBody),

    /// Response to 'disconnect' request. This is just an acknowledgement, so no body field is required.
    Disconnect,

    /// Response to 'evaluate' request.
    Evaluate(EvaluateResponseBody),

    /// Response to 'exceptionInfo' request.
    ExceptionInfo(ExceptionInfoResponseBody),

    /// Response to 'goto' request. This is just an acknowledgement, so no body field is required.
    Goto,

    /// Response to 'gotoTargets' request.
    GotoTargets(GotoTargetsResponseBody),

    /// Response to 'initialize' request.
    Initialize(Capabilities),

    /// Response to 'launch' request. This is just an acknowledgement, so no body field is required.
    Launch,

    /// Response to 'loadedSources' request.
    LoadedSources(LoadedSourcesResponseBody),

    /// Response to 'modules' request.
    Modules(ModulesResponseBody),

    /// Response to 'next' request. This is just an acknowledgement, so no body field is required.
    Next,

    /// Response to 'pause' request. This is just an acknowledgement, so no body field is required.
    Pause,

    /// Response to 'readMemory' request.
    ReadMemory(ReadMemoryResponseBody),

    /// Response to 'restartFrame' request. This is just an acknowledgement, so no body field is required.
    RestartFrame,

    /// Response to 'restart' request. This is just an acknowledgement, so no body field is required.
    Restart,

    /// Response to 'reverseContinue' request. This is just an acknowledgement, so no body field is required.
    ReverseContinue,

    /// Response to 'runInTerminal' request.
    RunInTerminal(RunInTerminalResponseBody),

    /// Response to 'scopes' request.
    Scopes(ScopesResponseBody),

    /// Response to 'setBreakpoints' request.
    ///
    /// Returned is information about each breakpoint created by this request.
    ///
    /// This includes the actual code location and whether the breakpoint could be verified.
    ///
    /// The breakpoints returned are in the same order as the elements of the 'breakpoints'
    ///
    /// (or the deprecated 'lines') array in the arguments.
    SetBreakpoints(SetBreakpointsResponseBody),

    /// Response to 'setDataBreakpoints' request.
    ///
    /// Returned is information about each breakpoint created by this request.
    SetDataBreakpoints(SetDataBreakpointsResponseBody),

    /// Response to 'setExceptionBreakpoints' request.
    ///
    /// The response contains an array of Breakpoint objects with information about each exception breakpoint or filter. The Breakpoint objects are in the same order as the elements of the 'filters', 'filterOptions', 'exceptionOptions' arrays given as arguments. If both 'filters' and 'filterOptions' are given, the returned array must start with 'filters' information first, followed by 'filterOptions' information.
    ///
    /// The mandatory 'verified' property of a Breakpoint object signals whether the exception breakpoint or filter could be successfully created and whether the optional condition or hit count expressions are valid. In case of an error the 'message' property explains the problem. An optional 'id' property can be used to introduce a unique ID for the exception breakpoint or filter so that it can be updated subsequently by sending breakpoint events.
    ///
    /// For backward compatibility both the 'breakpoints' array and the enclosing 'body' are optional. If these elements are missing a client will not be able to show problems for individual exception breakpoints or filters.
    SetExceptionBreakpoints(SetExceptionBreakpointsResponseBody),

    /// Response to 'setExpression' request.
    SetExpression(SetExpressionResponseBody),

    /// Response to 'setFunctionBreakpoints' request.
    ///
    /// Returned is information about each breakpoint created by this request.
    SetFunctionBreakpoints(SetFunctionBreakpointsResponseBody),

    /// Response to 'setInstructionBreakpoints' request
    SetInstructionBreakpoints(SetInstructionBreakpointsResponseBody),

    /// Response to 'setVariable' request.
    SetVariable(SetVariableResponseBody),

    /// Response to 'source' request.
    Source(SourceResponseBody),

    /// Response to 'stackTrace' request.
    StackTrace(StackTraceResponseBody),

    /// Response to 'stepBack' request. This is just an acknowledgement, so no body field is required.
    StepBack,

    /// Response to 'stepIn' request. This is just an acknowledgement, so no body field is required.
    StepIn,

    /// Response to 'stepInTargets' request.
    StepInTargets(StepInTargetsResponseBody),

    /// Response to 'stepOut' request. This is just an acknowledgement, so no body field is required.
    StepOut,

    /// Response to 'terminate' request. This is just an acknowledgement, so no body field is required.
    Terminate,

    /// Response to 'terminateThreads' request. This is just an acknowledgement, so no body field is required.
    TerminateThreads,

    /// Response to 'threads' request.
    Threads(ThreadsResponseBody),

    /// Response to 'variables' request.
    Variables(VariablesResponseBody),
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct BreakpointLocationsResponseBody {
    /// Sorted set of possible breakpoint locations.
    #[serde(rename = "breakpoints")]
    pub breakpoints: Vec<BreakpointLocation>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<BreakpointLocationsResponseBody> for SuccessResponse {
    fn from(args: BreakpointLocationsResponseBody) -> Self {
        Self::BreakpointLocations(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct CompletionsResponseBody {
    /// The possible completions for .
    #[serde(rename = "targets")]
    pub targets: Vec<CompletionItem>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<CompletionsResponseBody> for SuccessResponse {
    fn from(args: CompletionsResponseBody) -> Self {
        Self::Completions(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct ContinueResponseBody {
    /// If true, the 'continue' request has ignored the specified thread and continued all threads instead.
    ///
    /// If this attribute is missing a value of 'true' is assumed for backward compatibility.
    #[serde(rename = "allThreadsContinued", default = "true_")]
    #[builder(default)]
    pub all_threads_continued: bool,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<ContinueResponseBody> for SuccessResponse {
    fn from(args: ContinueResponseBody) -> Self {
        Self::Continue(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct DataBreakpointInfoResponseBody {
    /// An identifier for the data on which a data breakpoint can be registered with the setDataBreakpoints request or null if no data breakpoint is available.
    #[serde(rename = "dataId")]
    #[builder(default)]
    pub data_id: Option<String>,

    /// UI string that describes on what data the breakpoint is set on or why a data breakpoint is not available.
    #[serde(rename = "description")]
    pub description: String,

    /// Optional attribute listing the available access types for a potential data breakpoint. A UI frontend could surface this information.
    #[serde(rename = "accessTypes", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub access_types: Option<Vec<DataBreakpointAccessType>>,

    /// Optional attribute indicating that a potential data breakpoint could be persisted across sessions.
    #[serde(rename = "canPersist", default, skip_serializing_if = "eq_default")]
    #[builder(default)]
    pub can_persist: bool,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<DataBreakpointInfoResponseBody> for SuccessResponse {
    fn from(args: DataBreakpointInfoResponseBody) -> Self {
        Self::DataBreakpointInfo(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct DisassembleResponseBody {
    /// The list of disassembled instructions.
    #[serde(rename = "instructions")]
    pub instructions: Vec<DisassembledInstruction>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<DisassembleResponseBody> for SuccessResponse {
    fn from(args: DisassembleResponseBody) -> Self {
        Self::Disassemble(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct EvaluateResponseBody {
    /// The result of the evaluate request.
    #[serde(rename = "result")]
    pub result: String,

    /// The optional type of the evaluate result.
    ///
    /// This attribute should only be returned by a debug adapter if the client has passed the value true for the 'supportsVariableType' capability of the 'initialize' request.
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub type_: Option<String>,

    /// Properties of a evaluate result that can be used to determine how to render the result in the UI.
    #[serde(rename = "presentationHint", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub presentation_hint: Option<VariablePresentationHint>,

    /// If variablesReference is > 0, the evaluate result is structured and its children can be retrieved by passing variablesReference to the VariablesRequest.
    ///
    /// The value should be less than or equal to 2147483647 (2^31-1).
    #[serde(rename = "variablesReference")]
    pub variables_reference: i32,

    /// The number of named child variables.
    ///
    /// The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
    ///
    /// The value should be less than or equal to 2147483647 (2^31-1).
    #[serde(rename = "namedVariables", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub named_variables: Option<i32>,

    /// The number of indexed child variables.
    ///
    /// The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
    ///
    /// The value should be less than or equal to 2147483647 (2^31-1).
    #[serde(rename = "indexedVariables", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub indexed_variables: Option<i32>,

    /// Optional memory reference to a location appropriate for this result.
    ///
    /// For pointer type eval results, this is generally a reference to the memory address contained in the pointer.
    ///
    /// This attribute should be returned by a debug adapter if the client has passed the value true for the 'supportsMemoryReferences' capability of the 'initialize' request.
    #[serde(rename = "memoryReference", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub memory_reference: Option<String>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<EvaluateResponseBody> for SuccessResponse {
    fn from(args: EvaluateResponseBody) -> Self {
        Self::Evaluate(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct ExceptionInfoResponseBody {
    /// ID of the exception that was thrown.
    #[serde(rename = "exceptionId")]
    pub exception_id: String,

    /// Descriptive text for the exception provided by the debug adapter.
    #[serde(rename = "description", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub description: Option<String>,

    /// Mode that caused the exception notification to be raised.
    #[serde(rename = "breakMode")]
    pub break_mode: ExceptionBreakMode,

    /// Detailed information about the exception.
    #[serde(rename = "details", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub details: Option<ExceptionDetails>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<ExceptionInfoResponseBody> for SuccessResponse {
    fn from(args: ExceptionInfoResponseBody) -> Self {
        Self::ExceptionInfo(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct GotoTargetsResponseBody {
    /// The possible goto targets of the specified location.
    #[serde(rename = "targets")]
    pub targets: Vec<GotoTarget>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<GotoTargetsResponseBody> for SuccessResponse {
    fn from(args: GotoTargetsResponseBody) -> Self {
        Self::GotoTargets(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct LoadedSourcesResponseBody {
    /// Set of loaded sources.
    #[serde(rename = "sources")]
    pub sources: Vec<Source>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<LoadedSourcesResponseBody> for SuccessResponse {
    fn from(args: LoadedSourcesResponseBody) -> Self {
        Self::LoadedSources(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct ModulesResponseBody {
    /// All modules or range of modules.
    #[serde(rename = "modules")]
    pub modules: Vec<Module>,

    /// The total number of modules available.
    #[serde(rename = "totalModules", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub total_modules: Option<i32>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<ModulesResponseBody> for SuccessResponse {
    fn from(args: ModulesResponseBody) -> Self {
        Self::Modules(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct ReadMemoryResponseBody {
    /// The address of the first byte of data returned.
    ///
    /// Treated as a hex value if prefixed with '0x', or as a decimal value otherwise.
    #[serde(rename = "address")]
    pub address: String,

    /// The number of unreadable bytes encountered after the last successfully read byte.
    ///
    /// This can be used to determine the number of bytes that must be skipped before a subsequent 'readMemory' request will succeed.
    #[serde(rename = "unreadableBytes", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub unreadable_bytes: Option<i32>,

    /// The bytes read from memory, encoded using base64.
    #[serde(rename = "data", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub data: Option<String>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<ReadMemoryResponseBody> for SuccessResponse {
    fn from(args: ReadMemoryResponseBody) -> Self {
        Self::ReadMemory(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct RunInTerminalResponseBody {
    /// The process ID. The value should be less than or equal to 2147483647 (2^31-1).
    #[serde(rename = "processId", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub process_id: Option<i32>,

    /// The process ID of the terminal shell. The value should be less than or equal to 2147483647 (2^31-1).
    #[serde(rename = "shellProcessId", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub shell_process_id: Option<i32>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<RunInTerminalResponseBody> for SuccessResponse {
    fn from(args: RunInTerminalResponseBody) -> Self {
        Self::RunInTerminal(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct ScopesResponseBody {
    /// The scopes of the stackframe. If the array has length zero, there are no scopes available.
    #[serde(rename = "scopes")]
    pub scopes: Vec<Scope>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<ScopesResponseBody> for SuccessResponse {
    fn from(args: ScopesResponseBody) -> Self {
        Self::Scopes(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct SetBreakpointsResponseBody {
    /// Information about the breakpoints.
    ///
    /// The array elements are in the same order as the elements of the 'breakpoints' (or the deprecated 'lines') array in the arguments.
    #[serde(rename = "breakpoints")]
    pub breakpoints: Vec<Breakpoint>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<SetBreakpointsResponseBody> for SuccessResponse {
    fn from(args: SetBreakpointsResponseBody) -> Self {
        Self::SetBreakpoints(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct SetDataBreakpointsResponseBody {
    /// Information about the data breakpoints. The array elements correspond to the elements of the input argument 'breakpoints' array.
    #[serde(rename = "breakpoints")]
    pub breakpoints: Vec<Breakpoint>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<SetDataBreakpointsResponseBody> for SuccessResponse {
    fn from(args: SetDataBreakpointsResponseBody) -> Self {
        Self::SetDataBreakpoints(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct SetExceptionBreakpointsResponseBody {
    /// Information about the exception breakpoints or filters.
    ///
    /// The breakpoints returned are in the same order as the elements of the 'filters', 'filterOptions', 'exceptionOptions' arrays in the arguments. If both 'filters' and 'filterOptions' are given, the returned array must start with 'filters' information first, followed by 'filterOptions' information.
    #[serde(rename = "breakpoints", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub breakpoints: Option<Vec<Breakpoint>>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<SetExceptionBreakpointsResponseBody> for SuccessResponse {
    fn from(args: SetExceptionBreakpointsResponseBody) -> Self {
        Self::SetExceptionBreakpoints(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct SetExpressionResponseBody {
    /// The new value of the expression.
    #[serde(rename = "value")]
    pub value: String,

    /// The optional type of the value.
    ///
    /// This attribute should only be returned by a debug adapter if the client has passed the value true for the 'supportsVariableType' capability of the 'initialize' request.
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub type_: Option<String>,

    /// Properties of a value that can be used to determine how to render the result in the UI.
    #[serde(rename = "presentationHint", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub presentation_hint: Option<VariablePresentationHint>,

    /// If variablesReference is > 0, the value is structured and its children can be retrieved by passing variablesReference to the VariablesRequest.
    ///
    /// The value should be less than or equal to 2147483647 (2^31-1).
    #[serde(rename = "variablesReference", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub variables_reference: Option<i32>,

    /// The number of named child variables.
    ///
    /// The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
    ///
    /// The value should be less than or equal to 2147483647 (2^31-1).
    #[serde(rename = "namedVariables", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub named_variables: Option<i32>,

    /// The number of indexed child variables.
    ///
    /// The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
    ///
    /// The value should be less than or equal to 2147483647 (2^31-1).
    #[serde(rename = "indexedVariables", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub indexed_variables: Option<i32>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<SetExpressionResponseBody> for SuccessResponse {
    fn from(args: SetExpressionResponseBody) -> Self {
        Self::SetExpression(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct SetFunctionBreakpointsResponseBody {
    /// Information about the breakpoints. The array elements correspond to the elements of the 'breakpoints' array.
    #[serde(rename = "breakpoints")]
    pub breakpoints: Vec<Breakpoint>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<SetFunctionBreakpointsResponseBody> for SuccessResponse {
    fn from(args: SetFunctionBreakpointsResponseBody) -> Self {
        Self::SetFunctionBreakpoints(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct SetInstructionBreakpointsResponseBody {
    /// Information about the breakpoints. The array elements correspond to the elements of the 'breakpoints' array.
    #[serde(rename = "breakpoints")]
    pub breakpoints: Vec<Breakpoint>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<SetInstructionBreakpointsResponseBody> for SuccessResponse {
    fn from(args: SetInstructionBreakpointsResponseBody) -> Self {
        Self::SetInstructionBreakpoints(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct SetVariableResponseBody {
    /// The new value of the variable.
    #[serde(rename = "value")]
    pub value: String,

    /// The type of the new value. Typically shown in the UI when hovering over the value.
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub type_: Option<String>,

    /// If variablesReference is > 0, the new value is structured and its children can be retrieved by passing variablesReference to the VariablesRequest.
    ///
    /// The value should be less than or equal to 2147483647 (2^31-1).
    #[serde(rename = "variablesReference", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub variables_reference: Option<i32>,

    /// The number of named child variables.
    ///
    /// The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
    ///
    /// The value should be less than or equal to 2147483647 (2^31-1).
    #[serde(rename = "namedVariables", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub named_variables: Option<i32>,

    /// The number of indexed child variables.
    ///
    /// The client can use this optional information to present the variables in a paged UI and fetch them in chunks.
    ///
    /// The value should be less than or equal to 2147483647 (2^31-1).
    #[serde(rename = "indexedVariables", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub indexed_variables: Option<i32>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<SetVariableResponseBody> for SuccessResponse {
    fn from(args: SetVariableResponseBody) -> Self {
        Self::SetVariable(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct SourceResponseBody {
    /// Content of the source reference.
    #[serde(rename = "content")]
    pub content: String,

    /// Optional content type (mime type) of the source.
    #[serde(rename = "mimeType", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub mime_type: Option<String>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<SourceResponseBody> for SuccessResponse {
    fn from(args: SourceResponseBody) -> Self {
        Self::Source(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct StackTraceResponseBody {
    /// The frames of the stackframe. If the array has length zero, there are no stackframes available.
    ///
    /// This means that there is no location information available.
    #[serde(rename = "stackFrames")]
    pub stack_frames: Vec<StackFrame>,

    /// The total number of frames available in the stack. If omitted or if totalFrames is larger than the available frames, a client is expected to request frames until a request returns less frames than requested (which indicates the end of the stack). Returning monotonically increasing totalFrames values for subsequent requests can be used to enforce paging in the client.
    #[serde(rename = "totalFrames", skip_serializing_if = "Option::is_none")]
    #[builder(default)]
    pub total_frames: Option<i32>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<StackTraceResponseBody> for SuccessResponse {
    fn from(args: StackTraceResponseBody) -> Self {
        Self::StackTrace(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct StepInTargetsResponseBody {
    /// The possible stepIn targets of the specified source location.
    #[serde(rename = "targets")]
    pub targets: Vec<StepInTarget>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<StepInTargetsResponseBody> for SuccessResponse {
    fn from(args: StepInTargetsResponseBody) -> Self {
        Self::StepInTargets(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct ThreadsResponseBody {
    /// All threads.
    #[serde(rename = "threads")]
    pub threads: Vec<Thread>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<ThreadsResponseBody> for SuccessResponse {
    fn from(args: ThreadsResponseBody) -> Self {
        Self::Threads(args)
    }
}

#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize, TypedBuilder)]
pub struct VariablesResponseBody {
    /// All (or a range) of variables for the given variable reference.
    #[serde(rename = "variables")]
    pub variables: Vec<Variable>,

    #[serde(skip)]
    #[builder(default, setter(skip))]
    private: (),
}
impl From<VariablesResponseBody> for SuccessResponse {
    fn from(args: VariablesResponseBody) -> Self {
        Self::Variables(args)
    }
}

// Workaround from https://stackoverflow.com/a/65576570
// for https://github.com/serde-rs/serde/issues/745

fn deserialize_response_result<'de, D>(
    deserializer: D,
) -> Result<Result<SuccessResponse, ErrorResponse>, D::Error>
where
    D: Deserializer<'de>,
{
    let value = Value::deserialize(deserializer)?;

    let success = value
        .get("success")
        .ok_or_else(|| Error::missing_field("success"))?
        .as_bool()
        .ok_or_else(|| Error::invalid_type(unexpected_value(&value), &"success bool"))?;

    Ok(if success {
        Ok(Deserialize::deserialize(value).map_err(|e| Error::custom(e.to_string()))?)
    } else {
        Err(Deserialize::deserialize(value).map_err(|e| Error::custom(e.to_string()))?)
    })
}

fn unexpected_value<'l>(value: &'l Value) -> Unexpected<'l> {
    match value {
        Value::Null => Unexpected::Other("null"),
        Value::Bool(b) => Unexpected::Bool(*b),
        Value::Number(n) => unexpected_number(n),
        Value::String(s) => Unexpected::Str(s),
        Value::Array(_) => Unexpected::Seq,
        Value::Object(_) => Unexpected::Map,
    }
}

fn unexpected_number(number: &Number) -> Unexpected<'static> {
    if number.is_f64() {
        return Unexpected::Float(number.as_f64().unwrap());
    }
    if number.is_u64() {
        return Unexpected::Unsigned(number.as_u64().unwrap());
    }
    if number.is_i64() {
        return Unexpected::Signed(number.as_i64().unwrap());
    }
    panic!("Unknown number {}", number)
}

fn serialize_response_result<S>(
    result: &Result<SuccessResponse, ErrorResponse>,
    serializer: S,
) -> Result<S::Ok, S::Error>
where
    S: Serializer,
{
    #[derive(Clone, Serialize)]
    #[serde(untagged)]
    enum Content<'l> {
        Success(&'l SuccessResponse),
        Error(&'l ErrorResponse),
    }

    #[derive(Clone, Serialize)]
    struct TaggedContent<'l> {
        success: bool,
        #[serde(flatten)]
        content: Content<'l>,
    }

    let serializable = match result {
        Ok(response) => TaggedContent {
            success: true,
            content: Content::Success(response),
        },
        Err(response) => TaggedContent {
            success: false,
            content: Content::Error(response),
        },
    };
    serializable.serialize(serializer)
}