perforce-cli 0.2.3

A type-safe builder library for spawning Perforce (p4) commands, with compile-time option state isolation and multi-version support.
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
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
use std::path::{Path, PathBuf};
use std::process::{Child, Command, Stdio};

use super::{ExclusiveOption, SubCommand, Unselected};
use crate::global::GlobalOpts;
use crate::spawn::ParameterizedSpawn;

// ---------------------------------------------------------------------------
// Journal state (-J [-L limit])
// ---------------------------------------------------------------------------

/// The journal and log copy state of `p4 diagnostics`.
///
#[cfg_attr(
    feature = "lt2025_2",
    doc = "Carries the optional `-L limit` that caps the downloaded journal and log copy, which the basic form always includes."
)]
#[cfg_attr(
    not(feature = "lt2025_2"),
    doc = "Downloads a copy of the current journal file and log file (`-J`), optionally capped by `-L limit`."
)]
///
/// Entered with [`Diagnostics::journal`].
#[derive(Debug, Clone, Default)]
pub struct Journal {
    limit: Option<String>,
}

impl ExclusiveOption for Journal {
    fn inject_args(&self, command: &mut Command) {
        #[cfg(not(feature = "lt2025_2"))]
        command.arg("-J");

        if let Some(limit) = &self.limit {
            command.arg("-L").arg(limit);
        }
    }
}

// ---------------------------------------------------------------------------
// Strace state (-s [--strace-runtime secs])
// ---------------------------------------------------------------------------

/// The `strace` state of the advance form of `p4 diagnostics`.
///
#[cfg_attr(
    feature = "lt2025_2",
    doc = "Runs an `strace` command on the server processes for 20 seconds (`-s`)."
)]
#[cfg_attr(
    not(feature = "lt2025_2"),
    doc = "Runs an `strace` command on the server processes (`-s`), for 20 seconds by default or for the number of seconds given by `--strace-runtime secs`."
)]
///
/// Entered with [`Diagnostics::run_strace`] or
/// [`Diagnostics::run_strace_with`].
#[derive(Debug, Clone, Default)]
pub struct Strace {
    #[cfg(not(feature = "lt2025_2"))]
    runtime: Option<u64>,
}

impl ExclusiveOption for Strace {
    fn inject_args(&self, command: &mut Command) {
        command.arg("-s");

        #[cfg(not(feature = "lt2025_2"))]
        if let Some(runtime) = self.runtime {
            command.arg("--strace-runtime").arg(runtime.to_string());
        }
    }
}

// ---------------------------------------------------------------------------
// Basic form state (-j, -J [-L limit])
// ---------------------------------------------------------------------------

/// The basic form of `p4 diagnostics`.
///
#[cfg_attr(
    feature = "lt2025_2",
    doc = "Selected by `-L limit`; [`Diagnostics::basic`] enters this form explicitly."
)]
#[cfg_attr(
    not(feature = "lt2025_2"),
    doc = "Selected by `-j`, `-J`, or `-L limit`; [`Diagnostics::basic`] and [`Diagnostics::json_format`] enter this form."
)]
///
/// The `J` type parameter tracks the [`Journal`] state, starting as
/// [`Unselected`].
#[derive(Debug, Clone, Default)]
pub struct Basic<J = Unselected> {
    #[cfg(not(feature = "lt2025_2"))]
    json_format: bool,

    journal: J,
}

impl<J: ExclusiveOption> ExclusiveOption for Basic<J> {
    fn inject_args(&self, command: &mut Command) {
        #[cfg(not(feature = "lt2025_2"))]
        if self.json_format {
            command.arg("-j");
        }

        self.journal.inject_args(command);
    }
}

// ---------------------------------------------------------------------------
// Basic-files state of the advance form (-a [-J [-L limit]])
// ---------------------------------------------------------------------------

/// The basic diagnostic files state of the advance form of `p4 diagnostics`.
///
/// Requests that the basic diagnostic files are produced alongside the
/// advance-form data (`-a`). Entered with
/// [`Diagnostics::advance_with_basic`] or [`Diagnostics::with_basic`];
/// [`Diagnostics::journal`] then selects whether the journal and log copy is
/// also downloaded.
///
/// The `J` type parameter tracks the [`Journal`] state, starting as
/// [`Unselected`].
#[derive(Debug, Clone, Default)]
pub struct WithBasic<J = Unselected> {
    journal: J,
}

impl<J: ExclusiveOption> ExclusiveOption for WithBasic<J> {
    fn inject_args(&self, command: &mut Command) {
        command.arg("-a");

        self.journal.inject_args(command);
    }
}

// ---------------------------------------------------------------------------
// Advance form state (-l, -s, -p, -t, -a)
// ---------------------------------------------------------------------------

/// The advance form of `p4 diagnostics`.
///
#[cfg_attr(
    feature = "lt2025_2",
    doc = "Selected by `-l`, `-s`, or `-a`; [`Diagnostics::advance_with_basic`] enters this form explicitly."
)]
#[cfg_attr(
    not(feature = "lt2025_2"),
    doc = "Selected by `-l`, `-s`, `-p`, `-t`, or `-a`; [`Diagnostics::advance_with_basic`] enters this form explicitly."
)]
///
/// The `S` type parameter tracks the [`Strace`] state and the `B` type
/// parameter tracks the [`WithBasic`] state, each starting as
/// [`Unselected`].
#[derive(Debug, Clone, Default)]
pub struct Advance<S = Unselected, B = Unselected> {
    run_lsof: bool,

    #[cfg(not(feature = "lt2025_2"))]
    run_ps: bool,

    #[cfg(not(feature = "lt2025_2"))]
    run_top: bool,

    strace: S,

    basic: B,
}

impl<S: ExclusiveOption, B: ExclusiveOption> ExclusiveOption for Advance<S, B> {
    fn inject_args(&self, command: &mut Command) {
        if self.run_lsof {
            command.arg("-l");
        }

        self.strace.inject_args(command);

        #[cfg(not(feature = "lt2025_2"))]
        if self.run_ps {
            command.arg("-p");
        }

        #[cfg(not(feature = "lt2025_2"))]
        if self.run_top {
            command.arg("-t");
        }

        self.basic.inject_args(command);
    }
}

// ---------------------------------------------------------------------------
// Command
// ---------------------------------------------------------------------------

#[cfg_attr(
    feature = "lt2025_2",
    doc = "`p4 [g-opts] diagnostics [-L limit]`\n\n\
           `p4 [g-opts] diagnostics [-l] [-s] [-a [-L limit]]`"
)]
#[cfg_attr(
    not(feature = "lt2025_2"),
    doc = "`p4 [g-opts] diagnostics [-D] [-j] [-J [-L limit]]`\n\n\
           `p4 [g-opts] diagnostics [-D] [-l] [-s [--strace-runtime secs]] [-p] [-t] [-a [-J [-L limit]]]`"
)]
///
/// Generate diagnostic data about the P4 Server.
///
#[cfg_attr(
    feature = "lt2025_2",
    doc = "This command is a Technology Preview feature. Features offered in Technology Preview are experimental and not guaranteed to always work as expected. If you have feedback and functionality suggestions, email techpreview@perforce.com.",
    doc = "",
    doc = "The output format is subject to change. This command is currently intended for use under guidance by Perforce Support."
)]
#[cfg_attr(
    feature = "lt2025_2",
    doc = "",
    doc = "The first form of the command, `p4 [g-opts] diagnostics [-L limit]`, generates the basic diagnostic data and downloads it to a number of fixed named files in the current directory:",
    doc = "",
    doc = "- `diags` - basic configuration details, configuration, configuration history, server setting, and checkpoint history.",
    doc = "- `monitor` - the monitor records, if monitoring is enabled.",
    doc = "- `topology` - a textual description of the network that contains this server.",
    doc = "- A copy of the current `journal` and `log` files, using the configured names of these files.",
    doc = "",
    doc = "The second form of the command, `p4 [g-opts] diagnostics [-l] [-s] [-a [-L limit]]`, provides information that might take more time and require more server resources."
)]
#[cfg_attr(
    not(feature = "lt2025_2"),
    doc = "",
    doc = "The first form of the command generates the basic diagnostic data, and downloads a compressed tar file (`.tgz`) that contains these files:",
    doc = "",
    doc = "- `diags` - basic configuration details, configuration, configuration history, server setting.",
    doc = "- `info` - tagged output from the `p4 info` and `p4 servers -J` commands, and a list of all non-default configurables.",
    doc = "- `monitor` - the monitor records, if monitoring is enabled.",
    doc = "- `topology` - a textual description of the network that contains this server. Servers that do not have a serverID are ignored.",
    doc = "",
    doc = "The second form of the command provides information that might take more time and require more server resources."
)]
///
#[cfg_attr(
    feature = "lt2025_2",
    doc = "The `M` type parameter tracks the command form at compile time. The default [`Unselected`] state selects the basic form with no local options; `journal` and `basic` enter the [`Basic`] state, while `advance`, `advance_with_basic`, and the `run_*` transitions enter the [`Advance`] state."
)]
#[cfg_attr(
    not(feature = "lt2025_2"),
    doc = "The `M` type parameter tracks the command form at compile time. The default [`Unselected`] state selects the basic form with no local options; `journal`, `json_format`, and `basic` enter the [`Basic`] state, while `advance`, `advance_with_basic`, and the `run_*` transitions enter the [`Advance`] state."
)]
#[derive(Debug, Clone, Default)]
pub struct Diagnostics<M = Unselected> {
    bin: PathBuf,

    global_opts: GlobalOpts,

    #[cfg(not(feature = "lt2025_2"))]
    uncompressed: bool,

    mode: M,
}

impl Diagnostics<Unselected> {
    /// Creates a new `p4 diagnostics` command.
    ///
    /// `bin` is the path to the Perforce command-line executable.
    pub fn new(bin: impl Into<PathBuf>, global_opts: GlobalOpts) -> Self {
        Self {
            bin: bin.into(),
            global_opts,
            #[cfg(not(feature = "lt2025_2"))]
            uncompressed: false,
            mode: Unselected,
        }
    }

    /// Enters the [`Basic`] form of the command with no local options
    /// selected; equivalent to the default [`Unselected`] state.
    pub fn basic(self) -> Diagnostics<Basic<Unselected>> {
        Diagnostics {
            bin: self.bin,
            global_opts: self.global_opts,
            #[cfg(not(feature = "lt2025_2"))]
            uncompressed: self.uncompressed,
            mode: Basic {
                #[cfg(not(feature = "lt2025_2"))]
                json_format: false,
                journal: Unselected,
            },
        }
    }

    /// # Description
    ///
    /// -j
    ///
    /// Request that the `diags` and `monitor` files are encoded in JSON
    /// format. These output files are named `diags.json` and `monitor.json`.
    /// Any non-UFT8 sequences in a string are replaced by U+FFFD in the JSON
    /// output.
    ///
    /// Enters the [`Basic`] form of the command.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn json_format(self) -> Diagnostics<Basic<Unselected>> {
        Diagnostics {
            bin: self.bin,
            global_opts: self.global_opts,
            uncompressed: self.uncompressed,
            mode: Basic {
                json_format: true,
                journal: Unselected,
            },
        }
    }

    /// # Description
    ///
    /// -J [-L limit]
    ///
    /// Downloads a copy of the current journal file and log file, using the
    /// configured names of these files.
    ///
    /// Enters the [`Basic`] form of the command with the [`Journal`] state
    /// selected.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn journal(self) -> Diagnostics<Basic<Journal>> {
        Diagnostics {
            bin: self.bin,
            global_opts: self.global_opts,
            #[cfg(not(feature = "lt2025_2"))]
            uncompressed: self.uncompressed,
            mode: Basic {
                #[cfg(not(feature = "lt2025_2"))]
                json_format: false,
                journal: Journal::default(),
            },
        }
    }

    /// # Description
    ///
    /// -L limit
    ///
    /// The basic form always includes a copy of the journal and log files;
    /// this caps their download at the last `limit` bytes.
    ///
    /// Enters the [`Journal`] state with the journal and log copy limited to
    /// `limit`.
    #[cfg(feature = "lt2025_2")]
    pub fn limit(self, limit: impl Into<String>) -> Diagnostics<Basic<Journal>> {
        Diagnostics {
            bin: self.bin,
            global_opts: self.global_opts,
            mode: Basic {
                journal: Journal {
                    limit: Some(limit.into()),
                },
            },
        }
    }

    /// # Description
    ///
    /// -a
    ///
    #[cfg_attr(
        feature = "lt2025_2",
        doc = "Requests that the basic diagnostic files are produced. Without this option, those files are omitted with the `-l` and `-s` options."
    )]
    #[cfg_attr(
        not(feature = "lt2025_2"),
        doc = "Requests that the basic diagnostic files are produced. Without this option, those files are omitted with the `-l`, `-t`, `-p`, and `-s` options."
    )]
    ///
    /// Enters the [`Advance`] form of the command with the [`WithBasic`]
    /// state selected.
    pub fn advance_with_basic(self) -> Diagnostics<Advance<Unselected, WithBasic<Unselected>>> {
        Diagnostics {
            bin: self.bin,
            global_opts: self.global_opts,
            #[cfg(not(feature = "lt2025_2"))]
            uncompressed: self.uncompressed,
            mode: Advance {
                run_lsof: false,
                #[cfg(not(feature = "lt2025_2"))]
                run_ps: false,
                #[cfg(not(feature = "lt2025_2"))]
                run_top: false,
                strace: Unselected,
                basic: WithBasic::default(),
            },
        }
    }

    /// # Description
    ///
    /// -l
    ///
    /// Request that the `/usr/bin/lsof` be run to provide locking details of
    /// all files in use by P4 Servers on this system.
    #[cfg_attr(
        feature = "lt2025_2",
        doc = "The data from this operation is downloaded into a file named `manuallocks` in the current directory."
    )]
    #[cfg_attr(
        not(feature = "lt2025_2"),
        doc = "The data from this operation is downloaded into a file named `manuallocks`."
    )]
    /// *This option is not supported on Windows.*
    ///
    /// Enters the [`Advance`] form of the command.
    pub fn run_lsof(self) -> Diagnostics<Advance<Unselected, Unselected>> {
        Diagnostics {
            bin: self.bin,
            global_opts: self.global_opts,
            #[cfg(not(feature = "lt2025_2"))]
            uncompressed: self.uncompressed,
            mode: Advance {
                run_lsof: true,
                #[cfg(not(feature = "lt2025_2"))]
                run_ps: false,
                #[cfg(not(feature = "lt2025_2"))]
                run_top: false,
                strace: Unselected,
                basic: Unselected,
            },
        }
    }

    /// # Description
    ///
    /// -p
    ///
    /// Run the `ps` program and returns its output.
    ///
    /// Enters the [`Advance`] form of the command.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn run_ps(self) -> Diagnostics<Advance<Unselected, Unselected>> {
        Diagnostics {
            bin: self.bin,
            global_opts: self.global_opts,
            uncompressed: self.uncompressed,
            mode: Advance {
                run_lsof: false,
                run_ps: true,
                run_top: false,
                strace: Unselected,
                basic: Unselected,
            },
        }
    }

    /// # Description
    ///
    /// -t
    ///
    /// Run the `top` program and returns its output.
    ///
    /// Enters the [`Advance`] form of the command.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn run_top(self) -> Diagnostics<Advance<Unselected, Unselected>> {
        Diagnostics {
            bin: self.bin,
            global_opts: self.global_opts,
            uncompressed: self.uncompressed,
            mode: Advance {
                run_lsof: false,
                run_ps: false,
                run_top: true,
                strace: Unselected,
                basic: Unselected,
            },
        }
    }

    /// # Description
    ///
    /// -s
    ///
    #[cfg_attr(
        feature = "lt2025_2",
        doc = "Run an `strace` command on the server processes for 20 seconds and downloads the trace output to a file named `strace` in the current directory. *This option is not yet supported on any platform.*"
    )]
    #[cfg_attr(
        not(feature = "lt2025_2"),
        doc = "Run an `strace` command on the server processes for 20 seconds. The data from this operation is downloaded into a file named `strace`. *The `strace` Linux command is not supported on Windows.*"
    )]
    ///
    /// Enters the [`Advance`] form of the command with the [`Strace`] state
    /// selected.
    pub fn run_strace(self) -> Diagnostics<Advance<Strace, Unselected>> {
        Diagnostics {
            bin: self.bin,
            global_opts: self.global_opts,
            #[cfg(not(feature = "lt2025_2"))]
            uncompressed: self.uncompressed,
            mode: Advance {
                run_lsof: false,
                #[cfg(not(feature = "lt2025_2"))]
                run_ps: false,
                #[cfg(not(feature = "lt2025_2"))]
                run_top: false,
                strace: Strace::default(),
                basic: Unselected,
            },
        }
    }

    /// # Description
    ///
    /// `-s --strace-runtime secs`
    ///
    /// Run an `strace` command on the server processes for `secs` seconds
    /// instead of the default 20. The data from this operation is
    /// downloaded into a file named `strace`.
    /// *The `strace` Linux command is not supported on Windows.*
    ///
    /// Enters the [`Advance`] form of the command with the [`Strace`] state
    /// selected.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn run_strace_with(self, runtime: u64) -> Diagnostics<Advance<Strace, Unselected>> {
        Diagnostics {
            bin: self.bin,
            global_opts: self.global_opts,
            uncompressed: self.uncompressed,
            mode: Advance {
                run_lsof: false,
                run_ps: false,
                run_top: false,
                strace: Strace {
                    runtime: Some(runtime),
                },
                basic: Unselected,
            },
        }
    }
}

impl<J: ExclusiveOption> Diagnostics<Basic<J>> {
    /// # Description
    ///
    /// -j
    ///
    /// Request that the `diags` and `monitor` files are encoded in JSON
    /// format. These output files are named `diags.json` and `monitor.json`.
    /// Any non-UFT8 sequences in a string are replaced by U+FFFD in the JSON
    /// output.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn get_json_format(&self) -> bool {
        self.mode.json_format
    }

    /// # Description
    ///
    /// -j
    ///
    /// Request that the `diags` and `monitor` files are encoded in JSON
    /// format. These output files are named `diags.json` and `monitor.json`.
    /// Any non-UFT8 sequences in a string are replaced by U+FFFD in the JSON
    /// output.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn set_json_format(&mut self, v: bool) -> &mut Self {
        self.mode.json_format = v;
        self
    }

    /// # Description
    ///
    /// -j
    ///
    /// Request that the `diags` and `monitor` files are encoded in JSON
    /// format. These output files are named `diags.json` and `monitor.json`.
    /// Any non-UFT8 sequences in a string are replaced by U+FFFD in the JSON
    /// output.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn json_format(mut self, v: bool) -> Self {
        self.mode.json_format = v;
        self
    }
}

impl Diagnostics<Basic<Unselected>> {
    /// # Description
    ///
    /// -J [-L limit]
    ///
    /// Downloads a copy of the current journal file and log file, using the
    /// configured names of these files.
    ///
    /// Enters the [`Basic`] form of the command with the [`Journal`] state
    /// selected.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn journal(self) -> Diagnostics<Basic<Journal>> {
        Diagnostics {
            bin: self.bin,
            global_opts: self.global_opts,
            #[cfg(not(feature = "lt2025_2"))]
            uncompressed: self.uncompressed,
            mode: Basic {
                #[cfg(not(feature = "lt2025_2"))]
                json_format: self.mode.json_format,
                journal: Journal::default(),
            },
        }
    }

    /// # Description
    ///
    /// -J [-L limit]
    ///
    /// Downloads a copy of the current journal file and log file, using the
    /// configured names of these files.
    ///
    /// Enters the [`Basic`] form of the command with the [`Journal`] state
    /// selected and the download limited to `limit`.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn journal_with(self, limit: impl Into<String>) -> Diagnostics<Basic<Journal>> {
        self.journal().limit(limit)
    }

    /// # Description
    ///
    /// -L limit
    ///
    /// The basic form always includes a copy of the journal and log files;
    /// this caps their download at the last `limit` bytes.
    ///
    /// Enters the [`Journal`] state with the journal and log copy limited to
    /// `limit`.
    #[cfg(feature = "lt2025_2")]
    pub fn limit(self, limit: impl Into<String>) -> Diagnostics<Basic<Journal>> {
        Diagnostics {
            bin: self.bin,
            global_opts: self.global_opts,
            mode: Basic {
                journal: Journal {
                    limit: Some(limit.into()),
                },
            },
        }
    }
}

impl Diagnostics<Basic<Journal>> {
    /// # Description
    ///
    /// -L limit
    ///
    /// Limit the download size of the journal and log files to the last
    /// `limit` number of bytes of these files, subject to buffer rounding. The
    /// `limit` is in bytes and can be suffixed with a single character to
    /// designate a unit multiplier: `k` or `K` for kilobytes, `m` or `M` for
    /// megabytes, `g` or `G` for gigabytes, and `t` or `T` for terabytes.
    pub fn get_limit(&self) -> Option<&str> {
        self.mode.journal.limit.as_deref()
    }

    /// # Description
    ///
    /// -L limit
    ///
    /// Limit the download size of the journal and log files to the last
    /// `limit` number of bytes of these files, subject to buffer rounding. The
    /// `limit` is in bytes and can be suffixed with a single character to
    /// designate a unit multiplier: `k` or `K` for kilobytes, `m` or `M` for
    /// megabytes, `g` or `G` for gigabytes, and `t` or `T` for terabytes.
    pub fn set_limit(&mut self, v: impl Into<String>) -> &mut Self {
        self.mode.journal.limit = Some(v.into());
        self
    }

    /// # Description
    ///
    /// -L limit
    ///
    /// Limit the download size of the journal and log files to the last
    /// `limit` number of bytes of these files, subject to buffer rounding. The
    /// `limit` is in bytes and can be suffixed with a single character to
    /// designate a unit multiplier: `k` or `K` for kilobytes, `m` or `M` for
    /// megabytes, `g` or `G` for gigabytes, and `t` or `T` for terabytes.
    pub fn limit(mut self, v: impl Into<String>) -> Self {
        self.mode.journal.limit = Some(v.into());
        self
    }
}

impl<S: ExclusiveOption, B: ExclusiveOption> Diagnostics<Advance<S, B>> {
    /// # Description
    ///
    /// -l
    ///
    /// Request that the `/usr/bin/lsof` be run to provide locking details of
    /// all files in use by P4 Servers on this system.
    #[cfg_attr(
        feature = "lt2025_2",
        doc = "The data from this operation is downloaded into a file named `manuallocks` in the current directory."
    )]
    #[cfg_attr(
        not(feature = "lt2025_2"),
        doc = "The data from this operation is downloaded into a file named `manuallocks`."
    )]
    /// *This option is not supported on Windows.*
    pub fn get_run_lsof(&self) -> bool {
        self.mode.run_lsof
    }

    /// # Description
    ///
    /// -l
    ///
    /// Request that the `/usr/bin/lsof` be run to provide locking details of
    /// all files in use by P4 Servers on this system.
    #[cfg_attr(
        feature = "lt2025_2",
        doc = "The data from this operation is downloaded into a file named `manuallocks` in the current directory."
    )]
    #[cfg_attr(
        not(feature = "lt2025_2"),
        doc = "The data from this operation is downloaded into a file named `manuallocks`."
    )]
    /// *This option is not supported on Windows.*
    pub fn set_run_lsof(&mut self, v: bool) -> &mut Self {
        self.mode.run_lsof = v;
        self
    }

    /// # Description
    ///
    /// -l
    ///
    /// Request that the `/usr/bin/lsof` be run to provide locking details of
    /// all files in use by P4 Servers on this system.
    #[cfg_attr(
        feature = "lt2025_2",
        doc = "The data from this operation is downloaded into a file named `manuallocks` in the current directory."
    )]
    #[cfg_attr(
        not(feature = "lt2025_2"),
        doc = "The data from this operation is downloaded into a file named `manuallocks`."
    )]
    /// *This option is not supported on Windows.*
    pub fn run_lsof(mut self, v: bool) -> Self {
        self.mode.run_lsof = v;
        self
    }

    /// # Description
    ///
    /// -p
    ///
    /// Run the `ps` program and returns its output.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn get_run_ps(&self) -> bool {
        self.mode.run_ps
    }

    /// # Description
    ///
    /// -p
    ///
    /// Run the `ps` program and returns its output.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn set_run_ps(&mut self, v: bool) -> &mut Self {
        self.mode.run_ps = v;
        self
    }

    /// # Description
    ///
    /// -p
    ///
    /// Run the `ps` program and returns its output.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn run_ps(mut self, v: bool) -> Self {
        self.mode.run_ps = v;
        self
    }

    /// # Description
    ///
    /// -t
    ///
    /// Run the `top` program and returns its output.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn get_run_top(&self) -> bool {
        self.mode.run_top
    }

    /// # Description
    ///
    /// -t
    ///
    /// Run the `top` program and returns its output.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn set_run_top(&mut self, v: bool) -> &mut Self {
        self.mode.run_top = v;
        self
    }

    /// # Description
    ///
    /// -t
    ///
    /// Run the `top` program and returns its output.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn run_top(mut self, v: bool) -> Self {
        self.mode.run_top = v;
        self
    }

    /// # Description
    ///
    /// -s
    ///
    #[cfg_attr(
        feature = "lt2025_2",
        doc = "Run an `strace` command on the server processes for 20 seconds and downloads the trace output to a file named `strace` in the current directory. *This option is not yet supported on any platform.*"
    )]
    #[cfg_attr(
        not(feature = "lt2025_2"),
        doc = "Run an `strace` command on the server processes for 20 seconds. The data from this operation is downloaded into a file named `strace`. *The `strace` Linux command is not supported on Windows.*"
    )]
    pub fn run_strace(self) -> Diagnostics<Advance<Strace, B>> {
        Diagnostics {
            bin: self.bin,
            global_opts: self.global_opts,
            #[cfg(not(feature = "lt2025_2"))]
            uncompressed: self.uncompressed,
            mode: Advance {
                run_lsof: self.mode.run_lsof,
                #[cfg(not(feature = "lt2025_2"))]
                run_ps: self.mode.run_ps,
                #[cfg(not(feature = "lt2025_2"))]
                run_top: self.mode.run_top,
                strace: Strace::default(),
                basic: self.mode.basic,
            },
        }
    }

    /// # Description
    ///
    /// `-s --strace-runtime secs`
    ///
    /// Run an `strace` command on the server processes for `secs` seconds
    /// instead of the default 20. The data from this operation is
    /// downloaded into a file named `strace`.
    /// *The `strace` Linux command is not supported on Windows.*
    #[cfg(not(feature = "lt2025_2"))]
    pub fn run_strace_with(self, runtime: u64) -> Diagnostics<Advance<Strace, B>> {
        Diagnostics {
            bin: self.bin,
            global_opts: self.global_opts,
            uncompressed: self.uncompressed,
            mode: Advance {
                run_lsof: self.mode.run_lsof,
                run_ps: self.mode.run_ps,
                run_top: self.mode.run_top,
                strace: Strace {
                    runtime: Some(runtime),
                },
                basic: self.mode.basic,
            },
        }
    }
}

impl<S: ExclusiveOption> Diagnostics<Advance<S, Unselected>> {
    /// # Description
    ///
    /// -a
    ///
    #[cfg_attr(
        feature = "lt2025_2",
        doc = "Requests that the basic diagnostic files are produced. Without this option, those files are omitted with the `-l` and `-s` options."
    )]
    #[cfg_attr(
        not(feature = "lt2025_2"),
        doc = "Requests that the basic diagnostic files are produced. Without this option, those files are omitted with the `-l`, `-t`, `-p`, and `-s` options."
    )]
    ///
    /// Transitions this command to the [`WithBasic`] state.
    pub fn with_basic(self) -> Diagnostics<Advance<S, WithBasic<Unselected>>> {
        Diagnostics {
            bin: self.bin,
            global_opts: self.global_opts,
            #[cfg(not(feature = "lt2025_2"))]
            uncompressed: self.uncompressed,
            mode: Advance {
                run_lsof: self.mode.run_lsof,
                #[cfg(not(feature = "lt2025_2"))]
                run_ps: self.mode.run_ps,
                #[cfg(not(feature = "lt2025_2"))]
                run_top: self.mode.run_top,
                strace: self.mode.strace,
                basic: WithBasic::default(),
            },
        }
    }
}

impl<S: ExclusiveOption> Diagnostics<Advance<S, WithBasic<Unselected>>> {
    /// # Description
    ///
    /// -J [-L limit]
    ///
    /// Downloads a copy of the current journal file and log file, using the
    /// configured names of these files.
    ///
    /// Transitions this command to the [`Journal`] state.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn journal(self) -> Diagnostics<Advance<S, WithBasic<Journal>>> {
        Diagnostics {
            bin: self.bin,
            global_opts: self.global_opts,
            #[cfg(not(feature = "lt2025_2"))]
            uncompressed: self.uncompressed,
            mode: Advance {
                run_lsof: self.mode.run_lsof,
                #[cfg(not(feature = "lt2025_2"))]
                run_ps: self.mode.run_ps,
                #[cfg(not(feature = "lt2025_2"))]
                run_top: self.mode.run_top,
                strace: self.mode.strace,
                basic: WithBasic {
                    journal: Journal::default(),
                },
            },
        }
    }

    /// # Description
    ///
    /// -J [-L limit]
    ///
    /// Downloads a copy of the current journal file and log file, using the
    /// configured names of these files.
    ///
    /// Transitions this command to the [`Journal`] state with the download
    /// limited to `limit`.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn journal_with(
        self,
        limit: impl Into<String>,
    ) -> Diagnostics<Advance<S, WithBasic<Journal>>> {
        self.journal().limit(limit)
    }

    /// # Description
    ///
    /// -L limit
    ///
    /// The basic diagnostic files always include a copy of the journal and
    /// log files; this caps their download at the last `limit` bytes.
    ///
    /// Transitions this command to the [`Journal`] state with the journal and
    /// log copy limited to `limit`.
    #[cfg(feature = "lt2025_2")]
    pub fn limit(self, limit: impl Into<String>) -> Diagnostics<Advance<S, WithBasic<Journal>>> {
        Diagnostics {
            bin: self.bin,
            global_opts: self.global_opts,
            mode: Advance {
                run_lsof: self.mode.run_lsof,
                strace: self.mode.strace,
                basic: WithBasic {
                    journal: Journal {
                        limit: Some(limit.into()),
                    },
                },
            },
        }
    }
}

impl<S: ExclusiveOption> Diagnostics<Advance<S, WithBasic<Journal>>> {
    /// # Description
    ///
    /// -L limit
    ///
    /// Limit the download size of the journal and log files to the last
    /// `limit` number of bytes of these files, subject to buffer rounding. The
    /// `limit` is in bytes and can be suffixed with a single character to
    /// designate a unit multiplier: `k` or `K` for kilobytes, `m` or `M` for
    /// megabytes, `g` or `G` for gigabytes, and `t` or `T` for terabytes.
    pub fn get_limit(&self) -> Option<&str> {
        self.mode.basic.journal.limit.as_deref()
    }

    /// # Description
    ///
    /// -L limit
    ///
    /// Limit the download size of the journal and log files to the last
    /// `limit` number of bytes of these files, subject to buffer rounding. The
    /// `limit` is in bytes and can be suffixed with a single character to
    /// designate a unit multiplier: `k` or `K` for kilobytes, `m` or `M` for
    /// megabytes, `g` or `G` for gigabytes, and `t` or `T` for terabytes.
    pub fn set_limit(&mut self, v: impl Into<String>) -> &mut Self {
        self.mode.basic.journal.limit = Some(v.into());
        self
    }

    /// # Description
    ///
    /// -L limit
    ///
    /// Limit the download size of the journal and log files to the last
    /// `limit` number of bytes of these files, subject to buffer rounding. The
    /// `limit` is in bytes and can be suffixed with a single character to
    /// designate a unit multiplier: `k` or `K` for kilobytes, `m` or `M` for
    /// megabytes, `g` or `G` for gigabytes, and `t` or `T` for terabytes.
    pub fn limit(mut self, v: impl Into<String>) -> Self {
        self.mode.basic.journal.limit = Some(v.into());
        self
    }
}

impl<B: ExclusiveOption> Diagnostics<Advance<Strace, B>> {
    /// # Description
    ///
    /// `--strace-runtime secs`
    ///
    /// Run the `strace` command for `secs` seconds instead of the default 20.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn get_strace_runtime(&self) -> Option<u64> {
        self.mode.strace.runtime
    }

    /// # Description
    ///
    /// `--strace-runtime secs`
    ///
    /// Run the `strace` command for `secs` seconds instead of the default 20.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn set_strace_runtime(&mut self, v: u64) -> &mut Self {
        self.mode.strace.runtime = Some(v);
        self
    }

    /// # Description
    ///
    /// `--strace-runtime secs`
    ///
    /// Run the `strace` command for `secs` seconds instead of the default 20.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn strace_runtime(mut self, v: u64) -> Self {
        self.mode.strace.runtime = Some(v);
        self
    }
}

impl<M: ExclusiveOption> Diagnostics<M> {
    /// Get the Perforce command path.
    pub fn get_bin(&self) -> &Path {
        &self.bin
    }

    /// Set the Perforce command path.
    pub fn set_bin(&mut self, bin: impl Into<PathBuf>) -> &mut Self {
        self.bin = bin.into();
        self
    }

    /// Set the Perforce command path.
    pub fn bin(mut self, bin: impl Into<PathBuf>) -> Self {
        self.set_bin(bin);
        self
    }

    /// # Description
    ///
    /// -D
    ///
    /// Create a new directory and download the requested uncompressed
    /// individual files into this new directory. Without this option,
    /// download a single compressed tar file.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn get_uncompressed(&self) -> bool {
        self.uncompressed
    }

    /// # Description
    ///
    /// -D
    ///
    /// Create a new directory and download the requested uncompressed
    /// individual files into this new directory. Without this option,
    /// download a single compressed tar file.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn set_uncompressed(&mut self, v: bool) -> &mut Self {
        self.uncompressed = v;
        self
    }

    /// # Description
    ///
    /// -D
    ///
    /// Create a new directory and download the requested uncompressed
    /// individual files into this new directory. Without this option,
    /// download a single compressed tar file.
    #[cfg(not(feature = "lt2025_2"))]
    pub fn uncompressed(mut self, v: bool) -> Self {
        self.uncompressed = v;
        self
    }

    /// # Description
    ///
    /// g-opts
    ///
    /// See [Global options](GlobalOpts).
    pub fn get_global_opts(&self) -> &GlobalOpts {
        &self.global_opts
    }

    /// # Description
    ///
    /// g-opts
    ///
    /// See [Global options](GlobalOpts).
    pub fn set_global_opts(&mut self, v: GlobalOpts) -> &mut Self {
        self.global_opts = v;
        self
    }

    /// # Description
    ///
    /// g-opts
    ///
    /// See [Global options](GlobalOpts).
    pub fn global_opts(mut self, v: GlobalOpts) -> Self {
        self.global_opts = v;
        self
    }
}

impl<M: ExclusiveOption> SubCommand for Diagnostics<M> {
    fn name(&self) -> &str {
        "diagnostics"
    }

    fn inject_local_args(&self, command: &mut Command) {
        #[cfg(not(feature = "lt2025_2"))]
        if self.uncompressed {
            command.arg("-D");
        }

        self.mode.inject_args(command);
    }

    fn global_opts(&self) -> Option<&GlobalOpts> {
        Some(&self.global_opts)
    }
}

impl<M: ExclusiveOption> ParameterizedSpawn<()> for Diagnostics<M> {
    type Output = Child;
    type Error = std::io::Error;

    /// Spawns `p4 diagnostics` as a child process with piped standard output
    /// and error streams; use the returned [`Child`] handle to wait for it or
    /// interact with it.
    fn spawn_with(&mut self, (): ()) -> Result<Self::Output, Self::Error> {
        self.setup_command(&self.bin)
            .stdout(Stdio::piped())
            .stderr(Stdio::piped())
            .spawn()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::cmd::args_of;

    fn args(cmd: &impl SubCommand) -> Vec<String> {
        args_of(&cmd.setup_command("p4"))
    }

    #[test]
    fn plain_basic_form() {
        let cmd = Diagnostics::new("p4", GlobalOpts::new());
        assert_eq!(args(&cmd), ["diagnostics"]);
        assert_eq!(args(&cmd.basic()), ["diagnostics"]);
    }

    #[test]
    fn journal_with_limit() {
        #[cfg(not(feature = "lt2025_2"))]
        let cmd = Diagnostics::new("p4", GlobalOpts::new())
            .basic()
            .journal_with("10m");
        #[cfg(feature = "lt2025_2")]
        let cmd = Diagnostics::new("p4", GlobalOpts::new()).limit("10m");

        assert_eq!(cmd.get_limit(), Some("10m"));

        #[cfg(not(feature = "lt2025_2"))]
        assert_eq!(args(&cmd), ["diagnostics", "-J", "-L", "10m"]);

        #[cfg(feature = "lt2025_2")]
        assert_eq!(args(&cmd), ["diagnostics", "-L", "10m"]);
    }

    #[cfg(not(feature = "lt2025_2"))]
    #[test]
    fn json_format_with_journal() {
        let cmd = Diagnostics::new("p4", GlobalOpts::new())
            .json_format()
            .journal()
            .limit("1g");

        assert!(cmd.get_json_format());
        assert_eq!(args(&cmd), ["diagnostics", "-j", "-J", "-L", "1g"]);
    }

    #[cfg(not(feature = "lt2025_2"))]
    #[test]
    fn uncompressed_after_subcommand() {
        let cmd = Diagnostics::new("p4", GlobalOpts::new()).uncompressed(true);
        assert_eq!(args(&cmd), ["diagnostics", "-D"]);

        let cmd = cmd.journal();
        assert_eq!(args(&cmd), ["diagnostics", "-D", "-J"]);
    }

    #[test]
    fn advance_lsof_and_strace() {
        let cmd = Diagnostics::new("p4", GlobalOpts::new())
            .run_lsof()
            .run_strace();

        assert!(cmd.get_run_lsof());
        assert_eq!(args(&cmd), ["diagnostics", "-l", "-s"]);
    }

    #[test]
    fn advance_with_basic_journal_limit() {
        #[cfg(not(feature = "lt2025_2"))]
        let cmd = Diagnostics::new("p4", GlobalOpts::new())
            .advance_with_basic()
            .journal()
            .limit("10m");
        #[cfg(feature = "lt2025_2")]
        let cmd = Diagnostics::new("p4", GlobalOpts::new())
            .advance_with_basic()
            .limit("10m");

        assert_eq!(cmd.get_limit(), Some("10m"));

        #[cfg(not(feature = "lt2025_2"))]
        assert_eq!(args(&cmd), ["diagnostics", "-a", "-J", "-L", "10m"]);

        #[cfg(feature = "lt2025_2")]
        assert_eq!(args(&cmd), ["diagnostics", "-a", "-L", "10m"]);
    }

    #[test]
    fn with_basic_after_strace() {
        let cmd = Diagnostics::new("p4", GlobalOpts::new())
            .run_strace()
            .with_basic();

        assert_eq!(args(&cmd), ["diagnostics", "-s", "-a"]);
    }

    #[cfg(not(feature = "lt2025_2"))]
    #[test]
    fn strace_runtime() {
        let cmd = Diagnostics::new("p4", GlobalOpts::new()).run_strace_with(30);

        assert_eq!(cmd.get_strace_runtime(), Some(30));
        assert_eq!(args(&cmd), ["diagnostics", "-s", "--strace-runtime", "30"]);
    }

    #[cfg(not(feature = "lt2025_2"))]
    #[test]
    fn all_advance_options_in_syntax_order() {
        let cmd = Diagnostics::new("p4", GlobalOpts::new())
            .uncompressed(true)
            .run_lsof()
            .run_ps(true)
            .run_top(true)
            .run_strace_with(15);

        assert_eq!(
            args(&cmd),
            [
                "diagnostics",
                "-D",
                "-l",
                "-s",
                "--strace-runtime",
                "15",
                "-p",
                "-t"
            ]
        );
    }

    #[test]
    fn global_opts_are_injected_once() {
        let cmd = Diagnostics::new(
            "p4",
            GlobalOpts::new().port("localhost:1666").quiet_mode(true),
        )
        .run_lsof();

        assert_eq!(
            args(&cmd),
            ["-p", "localhost:1666", "-q", "diagnostics", "-l"]
        );
    }
}