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
use std::{
    ffi::OsStr,
    path::{Path, PathBuf},
    process::{Child, Stdio},
};

use super::SubCommand;

use crate::global::GlobalOpts;
use crate::spawn::ParameterizedSpawn;

#[cfg_attr(
    feature = "lt2016_1",
    doc = "`p4 [g-opts] delete [-c changelist] [-n -k -v] file ...`"
)]
#[cfg_attr(
    all(feature = "lt2024_1", not(feature = "lt2016_1")),
    doc = "`p4 [g-opts] delete [-c changelist] [-n -k -v] [--remote=remote] file ...`"
)]
#[cfg_attr(
    not(feature = "lt2024_1"),
    doc = "`p4 [g-opts] delete [-c PendingChangelist] [-n -k -v] [--remote=remote] FileSpec1 [[FileSpec]2 ...]`"
)]
///
#[cfg_attr(
    feature = "lt2024_1",
    doc = "Open file(s) in a client workspace for deletion from the depot."
)]
#[cfg_attr(
    not(feature = "lt2024_1"),
    doc = "Open files in a client workspace for deletion from the depot."
)]
#[derive(Debug, Clone, Default)]
pub struct Delete {
    bin: PathBuf,

    global_opts: GlobalOpts,

    changelist: Option<String>,

    preview: bool,

    keep_localfile: bool,

    delete_unsynced: bool,

    #[cfg(not(feature = "lt2016_1"))]
    remote: Option<String>,
}

impl SubCommand for Delete {
    fn name(&self) -> &str {
        "delete"
    }

    fn inject_local_args(&self, command: &mut std::process::Command) {
        if let Some(changelist) = self.changelist.as_ref() {
            command.arg("-c").arg(changelist);
        }
        if self.preview {
            command.arg("-n");
        }
        if self.keep_localfile {
            command.arg("-k");
        }
        if self.delete_unsynced {
            command.arg("-v");
        }
        #[cfg(not(feature = "lt2016_1"))]
        if let Some(remote) = self.remote.as_ref() {
            command.arg(format!("--remote={remote}"));
        }
    }

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

impl<S, I> ParameterizedSpawn<(S,)> for Delete
where
    S: IntoIterator<Item = I>,
    I: AsRef<OsStr>,
{
    type Output = Child;
    type Error = std::io::Error;

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

impl Delete {
    /// 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
    }

    #[cfg_attr(
        feature = "lt2024_1",
        doc = "Open file(s) in a client workspace for deletion from the depot."
    )]
    #[cfg_attr(
        not(feature = "lt2024_1"),
        doc = "Open files in a client workspace for deletion from the depot."
    )]
    ///
    /// `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,
            ..Default::default()
        }
    }

    /// # Description
    ///
    /// g-opts
    ///
    #[cfg_attr(
        feature = "lt2014_2",
        doc = "See the [Global Options](GlobalOpts) section."
    )]
    #[cfg_attr(
        all(feature = "lt2015_1", not(feature = "lt2014_2")),
        doc = "See the [“Global Options”](GlobalOpts) section."
    )]
    #[cfg_attr(
        all(feature = "lt2017_1", not(feature = "lt2015_1")),
        doc = "See [“Global Options”](GlobalOpts)."
    )]
    #[cfg_attr(
        all(feature = "lt2018_2", not(feature = "lt2017_1")),
        doc = "See [Global Options](GlobalOpts)."
    )]
    #[cfg_attr(not(feature = "lt2018_2"), doc = "See [Global options](GlobalOpts).")]
    pub fn get_global_opts(&self) -> &GlobalOpts {
        &self.global_opts
    }

    /// # Description
    ///
    /// g-opts
    ///
    #[cfg_attr(
        feature = "lt2014_2",
        doc = "See the [Global Options](GlobalOpts) section."
    )]
    #[cfg_attr(
        all(feature = "lt2015_1", not(feature = "lt2014_2")),
        doc = "See the [“Global Options”](GlobalOpts) section."
    )]
    #[cfg_attr(
        all(feature = "lt2017_1", not(feature = "lt2015_1")),
        doc = "See [“Global Options”](GlobalOpts)."
    )]
    #[cfg_attr(
        all(feature = "lt2018_2", not(feature = "lt2017_1")),
        doc = "See [Global Options](GlobalOpts)."
    )]
    #[cfg_attr(not(feature = "lt2018_2"), doc = "See [Global options](GlobalOpts).")]
    pub fn set_global_opts(&mut self, v: GlobalOpts) -> &mut Self {
        self.global_opts = v;
        self
    }

    /// # Description
    ///
    /// g-opts
    ///
    #[cfg_attr(
        feature = "lt2014_2",
        doc = "See the [Global Options](GlobalOpts) section."
    )]
    #[cfg_attr(
        all(feature = "lt2015_1", not(feature = "lt2014_2")),
        doc = "See the [“Global Options”](GlobalOpts) section."
    )]
    #[cfg_attr(
        all(feature = "lt2017_1", not(feature = "lt2015_1")),
        doc = "See [“Global Options”](GlobalOpts)."
    )]
    #[cfg_attr(
        all(feature = "lt2018_2", not(feature = "lt2017_1")),
        doc = "See [Global Options](GlobalOpts)."
    )]
    #[cfg_attr(not(feature = "lt2018_2"), doc = "See [Global options](GlobalOpts).")]
    pub fn global_opts(mut self, v: GlobalOpts) -> Self {
        self.global_opts = v;
        self
    }

    /// # Description
    ///
    #[cfg_attr(
        feature = "lt2014_2",
        doc = "-c changelist",
        doc = "",
        doc = "Opens the files for delete within the specified changelist.",
        doc = "",
        doc = "If this flag is not provided, the files are linked to the default changelist."
    )]
    #[cfg_attr(
        all(feature = "lt2024_1", not(feature = "lt2014_2")),
        doc = "-c changelist",
        doc = "",
        doc = "Opens the files for delete within the specified changelist.",
        doc = "",
        doc = "If this option is not provided, the files are linked to the default changelist."
    )]
    #[cfg_attr(
        not(feature = "lt2024_1"),
        doc = "-c PendingChangelist",
        doc = "",
        doc = "Opens files for `delete` and associates the deletion action with the specified pending changelist.",
        doc = "",
        doc = "If no pending changelist is specified, the deletion action is associated with the default changelist."
    )]
    pub fn get_changelist(&self) -> Option<&String> {
        self.changelist.as_ref()
    }

    /// # Description
    ///
    #[cfg_attr(
        feature = "lt2014_2",
        doc = "-c changelist",
        doc = "",
        doc = "Opens the files for delete within the specified changelist.",
        doc = "",
        doc = "If this flag is not provided, the files are linked to the default changelist."
    )]
    #[cfg_attr(
        all(feature = "lt2024_1", not(feature = "lt2014_2")),
        doc = "-c changelist",
        doc = "",
        doc = "Opens the files for delete within the specified changelist.",
        doc = "",
        doc = "If this option is not provided, the files are linked to the default changelist."
    )]
    #[cfg_attr(
        not(feature = "lt2024_1"),
        doc = "-c PendingChangelist",
        doc = "",
        doc = "Opens files for `delete` and associates the deletion action with the specified pending changelist.",
        doc = "",
        doc = "If no pending changelist is specified, the deletion action is associated with the default changelist."
    )]
    pub fn set_changelist(&mut self, v: impl Into<String>) -> &mut Self {
        self.changelist = Some(v.into());
        self
    }

    /// # Description
    ///
    #[cfg_attr(
        feature = "lt2014_2",
        doc = "-c changelist",
        doc = "",
        doc = "Opens the files for delete within the specified changelist.",
        doc = "",
        doc = "If this flag is not provided, the files are linked to the default changelist."
    )]
    #[cfg_attr(
        all(feature = "lt2024_1", not(feature = "lt2014_2")),
        doc = "-c changelist",
        doc = "",
        doc = "Opens the files for delete within the specified changelist.",
        doc = "",
        doc = "If this option is not provided, the files are linked to the default changelist."
    )]
    #[cfg_attr(
        not(feature = "lt2024_1"),
        doc = "-c PendingChangelist",
        doc = "",
        doc = "Opens files for `delete` and associates the deletion action with the specified pending changelist.",
        doc = "",
        doc = "If no pending changelist is specified, the deletion action is associated with the default changelist."
    )]
    pub fn changelist(mut self, v: impl Into<String>) -> Self {
        self.changelist = Some(v.into());
        self
    }

    /// # Description
    ///
    /// -n
    ///
    /// Preview which files would be opened for delete, without actually
    /// changing any files or metadata.
    pub fn get_preview(&self) -> bool {
        self.preview
    }

    /// # Description
    ///
    /// -n
    ///
    /// Preview which files would be opened for delete, without actually
    /// changing any files or metadata.
    pub fn set_preview(&mut self, v: bool) -> &mut Self {
        self.preview = v;
        self
    }

    /// # Description
    ///
    /// -n
    ///
    /// Preview which files would be opened for delete, without actually
    /// changing any files or metadata.
    pub fn preview(mut self, v: bool) -> Self {
        self.preview = v;
        self
    }

    /// # Description
    ///
    /// -k
    ///
    /// Delete the file on the shared versioning service, but keep a copy of
    /// the deleted file in your workspace.
    pub fn get_keep_localfile(&self) -> bool {
        self.keep_localfile
    }

    /// # Description
    ///
    /// -k
    ///
    /// Delete the file on the shared versioning service, but keep a copy of
    /// the deleted file in your workspace.
    pub fn set_keep_localfile(&mut self, v: bool) -> &mut Self {
        self.keep_localfile = v;
        self
    }

    /// # Description
    ///
    /// -k
    ///
    /// Delete the file on the shared versioning service, but keep a copy of
    /// the deleted file in your workspace.
    pub fn keep_localfile(mut self, v: bool) -> Self {
        self.keep_localfile = v;
        self
    }

    /// # Description
    ///
    /// -v
    ///
    /// Delete a file that is not synced into the client workspace.
    ///
    #[cfg_attr(
        feature = "lt2014_2",
        doc = "To use this flag, specify these files in depot syntax; because such files are not synced, client syntax or local syntax can introduce ambiguities in the list of files to delete. (If the files are synced, `p4 delete -v file` removes the files from your workspace in addition to opening them for deletion.) To delete a set of files without transferring them to your workstation, use `p4 sync -k file`, followed by `p4 delete -k file`."
    )]
    #[cfg_attr(
        all(feature = "lt2016_1", not(feature = "lt2014_2")),
        doc = "To use this option, specify these files in depot syntax; because such files are not synced, client syntax or local syntax can introduce ambiguities in the list of files to delete. (If the files are synced, `p4 delete -v file` removes the files from your workspace in addition to opening them for deletion.) To delete a set of files without transferring them to your workstation, use `p4 sync -k file`, followed by `p4 delete -k file`."
    )]
    #[cfg_attr(
        not(feature = "lt2016_1"),
        doc = "To use this option, specify these files in depot syntax; because such files are not synced, client syntax or local syntax can introduce ambiguities in the list of files to delete. (If the files are synced, `p4 delete -v file` removes the files from your workspace in addition to opening them for deletion.)",
        doc = "",
        doc = "To delete a set of files without transferring them to your workstation when another version of these files already exists in your workspace, use `p4 sync -k file`, followed by `p4 delete -k file`. This allows you to delete a file that is in the depot without affecting the file (by the same name) in your workspace. For example, if you have `myfile` version 5 in the depot and `myfile` version 6 in your workspace, this sequence of commands, allows you to keep version 6 but delete version 5. If you don't do this and just do `p4 delete -v`, it will delete version 5 in the depot and version 6 in the workspace."
    )]
    pub fn get_delete_unsynced(&self) -> bool {
        self.delete_unsynced
    }

    /// # Description
    ///
    /// -v
    ///
    /// Delete a file that is not synced into the client workspace.
    ///
    #[cfg_attr(
        feature = "lt2014_2",
        doc = "To use this flag, specify these files in depot syntax; because such files are not synced, client syntax or local syntax can introduce ambiguities in the list of files to delete. (If the files are synced, `p4 delete -v file` removes the files from your workspace in addition to opening them for deletion.) To delete a set of files without transferring them to your workstation, use `p4 sync -k file`, followed by `p4 delete -k file`."
    )]
    #[cfg_attr(
        all(feature = "lt2016_1", not(feature = "lt2014_2")),
        doc = "To use this option, specify these files in depot syntax; because such files are not synced, client syntax or local syntax can introduce ambiguities in the list of files to delete. (If the files are synced, `p4 delete -v file` removes the files from your workspace in addition to opening them for deletion.) To delete a set of files without transferring them to your workstation, use `p4 sync -k file`, followed by `p4 delete -k file`."
    )]
    #[cfg_attr(
        not(feature = "lt2016_1"),
        doc = "To use this option, specify these files in depot syntax; because such files are not synced, client syntax or local syntax can introduce ambiguities in the list of files to delete. (If the files are synced, `p4 delete -v file` removes the files from your workspace in addition to opening them for deletion.)",
        doc = "",
        doc = "To delete a set of files without transferring them to your workstation when another version of these files already exists in your workspace, use `p4 sync -k file`, followed by `p4 delete -k file`. This allows you to delete a file that is in the depot without affecting the file (by the same name) in your workspace. For example, if you have `myfile` version 5 in the depot and `myfile` version 6 in your workspace, this sequence of commands, allows you to keep version 6 but delete version 5. If you don't do this and just do `p4 delete -v`, it will delete version 5 in the depot and version 6 in the workspace."
    )]
    pub fn set_delete_unsynced(&mut self, v: bool) -> &mut Self {
        self.delete_unsynced = v;
        self
    }

    /// # Description
    ///
    /// -v
    ///
    /// Delete a file that is not synced into the client workspace.
    ///
    #[cfg_attr(
        feature = "lt2014_2",
        doc = "To use this flag, specify these files in depot syntax; because such files are not synced, client syntax or local syntax can introduce ambiguities in the list of files to delete. (If the files are synced, `p4 delete -v file` removes the files from your workspace in addition to opening them for deletion.) To delete a set of files without transferring them to your workstation, use `p4 sync -k file`, followed by `p4 delete -k file`."
    )]
    #[cfg_attr(
        all(feature = "lt2016_1", not(feature = "lt2014_2")),
        doc = "To use this option, specify these files in depot syntax; because such files are not synced, client syntax or local syntax can introduce ambiguities in the list of files to delete. (If the files are synced, `p4 delete -v file` removes the files from your workspace in addition to opening them for deletion.) To delete a set of files without transferring them to your workstation, use `p4 sync -k file`, followed by `p4 delete -k file`."
    )]
    #[cfg_attr(
        not(feature = "lt2016_1"),
        doc = "To use this option, specify these files in depot syntax; because such files are not synced, client syntax or local syntax can introduce ambiguities in the list of files to delete. (If the files are synced, `p4 delete -v file` removes the files from your workspace in addition to opening them for deletion.)",
        doc = "",
        doc = "To delete a set of files without transferring them to your workstation when another version of these files already exists in your workspace, use `p4 sync -k file`, followed by `p4 delete -k file`. This allows you to delete a file that is in the depot without affecting the file (by the same name) in your workspace. For example, if you have `myfile` version 5 in the depot and `myfile` version 6 in your workspace, this sequence of commands, allows you to keep version 6 but delete version 5. If you don't do this and just do `p4 delete -v`, it will delete version 5 in the depot and version 6 in the workspace."
    )]
    pub fn delete_unsynced(mut self, v: bool) -> Self {
        self.delete_unsynced = v;
        self
    }

    /// # Description
    ///
    /// `--remote=remote`
    ///
    /// Opens the file for delete in your personal server, and additionally —
    /// if the file is of type `+l` — takes a global exclusive lock on the file
    /// in the shared server from which you cloned the file.
    #[cfg(not(feature = "lt2016_1"))]
    pub fn get_remote(&self) -> Option<&String> {
        self.remote.as_ref()
    }

    /// # Description
    ///
    /// `--remote=remote`
    ///
    /// Opens the file for delete in your personal server, and additionally —
    /// if the file is of type `+l` — takes a global exclusive lock on the file
    /// in the shared server from which you cloned the file.
    #[cfg(not(feature = "lt2016_1"))]
    pub fn set_remote(&mut self, v: impl Into<String>) -> &mut Self {
        self.remote = Some(v.into());
        self
    }

    /// # Description
    ///
    /// `--remote=remote`
    ///
    /// Opens the file for delete in your personal server, and additionally —
    /// if the file is of type `+l` — takes a global exclusive lock on the file
    /// in the shared server from which you cloned the file.
    #[cfg(not(feature = "lt2016_1"))]
    pub fn remote(mut self, v: impl Into<String>) -> Self {
        self.remote = Some(v.into());
        self
    }
}