ModularPipelines/src/ModularPipelines.Rust/Services/ICargo.Generated.cs at c6e8d6001d59e0b9ed751880ea3a56896add5c9e · thomhurst/ModularPipelines · GitHub

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
// <auto-generated>
// This file was generated by ModularPipelines.OptionsGenerator.
// Do not edit this file manually.
// </auto-generated>

#nullable enable

using System.CodeDom.Compiler;
using ModularPipelines.Models;
using ModularPipelines.Options;
using ModularPipelines.Rust.Options;

namespace ModularPipelines.Rust.Services;

/// <summary>
/// Generated interface for cargo CLI commands.
/// </summary>
[GeneratedCode("ModularPipelines.OptionsGenerator", "")]
public partial interface ICargo
{
    #region Commands

    /// <summary>
    /// Add dependencies to a Cargo.toml manifest file
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    Task<CommandResult> Add(CargoAddOptions options = default, CommandExecutionOptions executionOptions = null, CancellationToken cancellationToken = default);

    /// <summary>
    /// Execute all benchmarks of a local package
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    Task<CommandResult> Bench(CargoBenchOptions options = default, CommandExecutionOptions executionOptions = null, CancellationToken cancellationToken = default);

    /// <summary>
    /// Compile a local package and all of its dependencies
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    Task<CommandResult> Build(CargoBuildOptions options = default, CommandExecutionOptions executionOptions = null, CancellationToken cancellationToken = default);

    /// <summary>
    /// Check a local package and all of its dependencies for errors
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    Task<CommandResult> Check(CargoCheckOptions options = default, CommandExecutionOptions executionOptions = null, CancellationToken cancellationToken = default);

    /// <summary>
    /// Remove artifacts that cargo has generated in the past
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    Task<CommandResult> Clean(CargoCleanOptions options = default, CommandExecutionOptions executionOptions = null, CancellationToken cancellationToken = default);

    /// <summary>
    /// Build a package's documentation
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    Task<CommandResult> Doc(CargoDocOptions options = default, CommandExecutionOptions executionOptions = null, CancellationToken cancellationToken = default);

    /// <summary>
    /// Create a new cargo package in an existing directory
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    Task<CommandResult> Init(CargoInitOptions options = default, CommandExecutionOptions executionOptions = null, CancellationToken cancellationToken = default);

    /// <summary>
    /// Install a Rust binary
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    Task<CommandResult> Install(CargoInstallOptions options = default, CommandExecutionOptions executionOptions = null, CancellationToken cancellationToken = default);

    /// <summary>
    /// Create a new cargo package at &lt;path&gt;
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    Task<CommandResult> New(CargoNewOptions options = default, CommandExecutionOptions executionOptions = null, CancellationToken cancellationToken = default);

    /// <summary>
    /// Upload a package to the registry
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    Task<CommandResult> Publish(CargoPublishOptions options = default, CommandExecutionOptions executionOptions = null, CancellationToken cancellationToken = default);

    /// <summary>
    /// Remove dependencies from a Cargo.toml manifest file
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    Task<CommandResult> Remove(CargoRemoveOptions options = default, CommandExecutionOptions executionOptions = null, CancellationToken cancellationToken = default);

    /// <summary>
    /// Run a binary or example of the local package
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    Task<CommandResult> Run(CargoRunOptions options = default, CommandExecutionOptions executionOptions = null, CancellationToken cancellationToken = default);

    /// <summary>
    /// Search packages in the registry. Default registry is crates.io
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    Task<CommandResult> Search(CargoSearchOptions options = default, CommandExecutionOptions executionOptions = null, CancellationToken cancellationToken = default);

    /// <summary>
    /// Execute all unit and integration tests and build examples of a local package
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    Task<CommandResult> Test(CargoTestOptions options = default, CommandExecutionOptions executionOptions = null, CancellationToken cancellationToken = default);

    /// <summary>
    /// Remove a Rust binary
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    Task<CommandResult> Uninstall(CargoUninstallOptions options = default, CommandExecutionOptions executionOptions = null, CancellationToken cancellationToken = default);

    /// <summary>
    /// Update dependencies as recorded in the local lock file
    /// </summary>
    /// <param name="options">The command options.</param>
    /// <param name="executionOptions">The execution configuration options.</param>
    /// <param name="cancellationToken">Cancellation token.</param>
    /// <returns>The command result.</returns>
    Task<CommandResult> Update(CargoUpdateOptions options = default, CommandExecutionOptions executionOptions = null, CancellationToken cancellationToken = default);

    #endregion
}