CliWrap.xml 57 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>CliWrap</name>
  5. </assembly>
  6. <members>
  7. <member name="T:CliWrap.Buffered.BufferedCommandExtensions">
  8. <summary>
  9. Buffered execution model.
  10. </summary>
  11. </member>
  12. <member name="M:CliWrap.Buffered.BufferedCommandExtensions.ExecuteBufferedAsync(CliWrap.Command,System.Text.Encoding,System.Text.Encoding,System.Threading.CancellationToken,System.Threading.CancellationToken)">
  13. <summary>
  14. Executes the command asynchronously with buffering.
  15. Data written to the standard output and standard error streams is decoded as text
  16. and returned as part of the result object.
  17. </summary>
  18. <remarks>
  19. This method can be awaited.
  20. </remarks>
  21. </member>
  22. <member name="M:CliWrap.Buffered.BufferedCommandExtensions.ExecuteBufferedAsync(CliWrap.Command,System.Text.Encoding,System.Text.Encoding,System.Threading.CancellationToken)">
  23. <summary>
  24. Executes the command asynchronously with buffering.
  25. Data written to the standard output and standard error streams is decoded as text
  26. and returned as part of the result object.
  27. </summary>
  28. <remarks>
  29. This method can be awaited.
  30. </remarks>
  31. </member>
  32. <member name="M:CliWrap.Buffered.BufferedCommandExtensions.ExecuteBufferedAsync(CliWrap.Command,System.Text.Encoding,System.Threading.CancellationToken)">
  33. <summary>
  34. Executes the command asynchronously with buffering.
  35. Data written to the standard output and standard error streams is decoded as text
  36. and returned as part of the result object.
  37. </summary>
  38. <remarks>
  39. This method can be awaited.
  40. </remarks>
  41. </member>
  42. <member name="M:CliWrap.Buffered.BufferedCommandExtensions.ExecuteBufferedAsync(CliWrap.Command,System.Threading.CancellationToken)">
  43. <summary>
  44. Executes the command asynchronously with buffering.
  45. Data written to the standard output and standard error streams is decoded as text
  46. and returned as part of the result object.
  47. Uses <see cref="P:System.Text.Encoding.Default" /> for decoding.
  48. </summary>
  49. <remarks>
  50. This method can be awaited.
  51. </remarks>
  52. </member>
  53. <member name="T:CliWrap.Buffered.BufferedCommandResult">
  54. <summary>
  55. Result of a command execution, with buffered text data from standard output and standard error streams.
  56. </summary>
  57. </member>
  58. <member name="M:CliWrap.Buffered.BufferedCommandResult.#ctor(System.Int32,System.DateTimeOffset,System.DateTimeOffset,System.String,System.String)">
  59. <summary>
  60. Result of a command execution, with buffered text data from standard output and standard error streams.
  61. </summary>
  62. </member>
  63. <member name="P:CliWrap.Buffered.BufferedCommandResult.StandardOutput">
  64. <summary>
  65. Standard output data produced by the underlying process.
  66. </summary>
  67. </member>
  68. <member name="P:CliWrap.Buffered.BufferedCommandResult.StandardError">
  69. <summary>
  70. Standard error data produced by the underlying process.
  71. </summary>
  72. </member>
  73. <member name="T:CliWrap.Builders.ArgumentsBuilder">
  74. <summary>
  75. Builder that helps format command-line arguments into a string.
  76. </summary>
  77. </member>
  78. <member name="M:CliWrap.Builders.ArgumentsBuilder.Add(System.String,System.Boolean)">
  79. <summary>
  80. Adds the specified value to the list of arguments.
  81. </summary>
  82. </member>
  83. <member name="M:CliWrap.Builders.ArgumentsBuilder.Add(System.String)">
  84. <summary>
  85. Adds the specified value to the list of arguments.
  86. </summary>
  87. </member>
  88. <member name="M:CliWrap.Builders.ArgumentsBuilder.Add(System.Collections.Generic.IEnumerable{System.String},System.Boolean)">
  89. <summary>
  90. Adds the specified values to the list of arguments.
  91. </summary>
  92. </member>
  93. <member name="M:CliWrap.Builders.ArgumentsBuilder.Add(System.Collections.Generic.IEnumerable{System.String})">
  94. <summary>
  95. Adds the specified values to the list of arguments.
  96. </summary>
  97. </member>
  98. <member name="M:CliWrap.Builders.ArgumentsBuilder.Add(System.IFormattable,System.IFormatProvider,System.Boolean)">
  99. <summary>
  100. Adds the specified value to the list of arguments.
  101. </summary>
  102. </member>
  103. <member name="M:CliWrap.Builders.ArgumentsBuilder.Add(System.IFormattable,System.Globalization.CultureInfo,System.Boolean)">
  104. <summary>
  105. Adds the specified value to the list of arguments.
  106. </summary>
  107. </member>
  108. <member name="M:CliWrap.Builders.ArgumentsBuilder.Add(System.IFormattable,System.Globalization.CultureInfo)">
  109. <summary>
  110. Adds the specified value to the list of arguments.
  111. </summary>
  112. </member>
  113. <member name="M:CliWrap.Builders.ArgumentsBuilder.Add(System.IFormattable,System.Boolean)">
  114. <summary>
  115. Adds the specified value to the list of arguments.
  116. The value is converted to string using invariant culture.
  117. </summary>
  118. </member>
  119. <member name="M:CliWrap.Builders.ArgumentsBuilder.Add(System.IFormattable)">
  120. <summary>
  121. Adds the specified value to the list of arguments.
  122. The value is converted to string using invariant culture.
  123. </summary>
  124. </member>
  125. <member name="M:CliWrap.Builders.ArgumentsBuilder.Add(System.Collections.Generic.IEnumerable{System.IFormattable},System.IFormatProvider,System.Boolean)">
  126. <summary>
  127. Adds the specified values to the list of arguments.
  128. </summary>
  129. </member>
  130. <member name="M:CliWrap.Builders.ArgumentsBuilder.Add(System.Collections.Generic.IEnumerable{System.IFormattable},System.Globalization.CultureInfo,System.Boolean)">
  131. <summary>
  132. Adds the specified values to the list of arguments.
  133. </summary>
  134. </member>
  135. <member name="M:CliWrap.Builders.ArgumentsBuilder.Add(System.Collections.Generic.IEnumerable{System.IFormattable},System.Globalization.CultureInfo)">
  136. <summary>
  137. Adds the specified values to the list of arguments.
  138. </summary>
  139. </member>
  140. <member name="M:CliWrap.Builders.ArgumentsBuilder.Add(System.Collections.Generic.IEnumerable{System.IFormattable},System.Boolean)">
  141. <summary>
  142. Adds the specified values to the list of arguments.
  143. The values are converted to string using invariant culture.
  144. </summary>
  145. </member>
  146. <member name="M:CliWrap.Builders.ArgumentsBuilder.Add(System.Collections.Generic.IEnumerable{System.IFormattable})">
  147. <summary>
  148. Adds the specified values to the list of arguments.
  149. The values are converted to string using invariant culture.
  150. </summary>
  151. </member>
  152. <member name="M:CliWrap.Builders.ArgumentsBuilder.Build">
  153. <summary>
  154. Builds the resulting arguments string.
  155. </summary>
  156. </member>
  157. <member name="M:CliWrap.Builders.ArgumentsBuilder.Escape(System.String)">
  158. <summary>
  159. Escapes special characters (spaces, slashes, and quotes) in the specified string, ensuring that the output
  160. is correctly interpreted as a single argument when passed to a command-line application.
  161. </summary>
  162. <remarks>
  163. In most cases, you should not need to use this method, as <see cref="T:CliWrap.Builders.ArgumentsBuilder" /> already escapes
  164. arguments automatically. This method is provided for advanced scenarios where you need to escape arguments
  165. manually.
  166. </remarks>
  167. </member>
  168. <member name="T:CliWrap.Builders.CredentialsBuilder">
  169. <summary>
  170. Builder that helps configure user credentials.
  171. </summary>
  172. </member>
  173. <member name="M:CliWrap.Builders.CredentialsBuilder.SetDomain(System.String)">
  174. <summary>
  175. Sets the Active Directory domain used when starting the process.
  176. </summary>
  177. <remarks>
  178. For information on platform support, see attributes on <see cref="P:System.Diagnostics.ProcessStartInfo.Domain" />.
  179. </remarks>
  180. </member>
  181. <member name="M:CliWrap.Builders.CredentialsBuilder.SetUserName(System.String)">
  182. <summary>
  183. Sets the username used when starting the process.
  184. </summary>
  185. <remarks>
  186. For information on platform support, see attributes on <see cref="P:System.Diagnostics.ProcessStartInfo.UserName" />.
  187. </remarks>
  188. </member>
  189. <member name="M:CliWrap.Builders.CredentialsBuilder.SetPassword(System.String)">
  190. <summary>
  191. Sets the password used when starting the process.
  192. </summary>
  193. <remarks>
  194. For information on platform support, see attributes on <see cref="P:System.Diagnostics.ProcessStartInfo.Password" />.
  195. </remarks>
  196. </member>
  197. <member name="M:CliWrap.Builders.CredentialsBuilder.LoadUserProfile(System.Boolean)">
  198. <summary>
  199. Instructs whether to load the user profile when starting the process.
  200. </summary>
  201. <remarks>
  202. For information on platform support, see attributes on <see cref="P:System.Diagnostics.ProcessStartInfo.LoadUserProfile" />.
  203. </remarks>
  204. </member>
  205. <member name="M:CliWrap.Builders.CredentialsBuilder.Build">
  206. <summary>
  207. Builds the resulting credentials.
  208. </summary>
  209. </member>
  210. <member name="T:CliWrap.Builders.EnvironmentVariablesBuilder">
  211. <summary>
  212. Builder that helps configure environment variables.
  213. </summary>
  214. </member>
  215. <member name="M:CliWrap.Builders.EnvironmentVariablesBuilder.Set(System.String,System.String)">
  216. <summary>
  217. Sets an environment variable with the specified name to the specified value.
  218. </summary>
  219. </member>
  220. <member name="M:CliWrap.Builders.EnvironmentVariablesBuilder.Set(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}})">
  221. <summary>
  222. Sets multiple environment variables from the specified sequence of key-value pairs.
  223. </summary>
  224. </member>
  225. <member name="M:CliWrap.Builders.EnvironmentVariablesBuilder.Set(System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})">
  226. <summary>
  227. Sets multiple environment variables from the specified dictionary.
  228. </summary>
  229. </member>
  230. <member name="M:CliWrap.Builders.EnvironmentVariablesBuilder.Build">
  231. <summary>
  232. Builds the resulting environment variables.
  233. </summary>
  234. </member>
  235. <member name="T:CliWrap.Builders.ResourcePolicyBuilder">
  236. <summary>
  237. Builder that helps configure resource policy.
  238. </summary>
  239. </member>
  240. <member name="M:CliWrap.Builders.ResourcePolicyBuilder.SetPriority(System.Nullable{System.Diagnostics.ProcessPriorityClass})">
  241. <summary>
  242. Sets the priority class of the process.
  243. </summary>
  244. <remarks>
  245. For information on platform support, see attributes on <see cref="P:System.Diagnostics.Process.PriorityClass" />.
  246. </remarks>
  247. </member>
  248. <member name="M:CliWrap.Builders.ResourcePolicyBuilder.SetAffinity(System.Nullable{System.IntPtr})">
  249. <summary>
  250. Sets the processor core affinity mask of the process.
  251. For example, to set the affinity to cores 1 and 3 out of 4, pass 0b1010.
  252. </summary>
  253. <remarks>
  254. For information on platform support, see attributes on <see cref="P:System.Diagnostics.Process.ProcessorAffinity" />.
  255. </remarks>
  256. </member>
  257. <member name="M:CliWrap.Builders.ResourcePolicyBuilder.SetMinWorkingSet(System.Nullable{System.IntPtr})">
  258. <summary>
  259. Sets the minimum working set size of the process.
  260. </summary>
  261. <remarks>
  262. For information on platform support, see attributes on <see cref="P:System.Diagnostics.Process.MinWorkingSet" />.
  263. </remarks>
  264. </member>
  265. <member name="M:CliWrap.Builders.ResourcePolicyBuilder.SetMaxWorkingSet(System.Nullable{System.IntPtr})">
  266. <summary>
  267. Sets the maximum working set size of the process.
  268. </summary>
  269. <remarks>
  270. For information on platform support, see attributes on <see cref="P:System.Diagnostics.Process.MaxWorkingSet" />.
  271. </remarks>
  272. </member>
  273. <member name="M:CliWrap.Builders.ResourcePolicyBuilder.Build">
  274. <summary>
  275. Builds the resulting resource policy.
  276. </summary>
  277. </member>
  278. <member name="T:CliWrap.Cli">
  279. <summary>
  280. Main entry point for creating new commands.
  281. </summary>
  282. </member>
  283. <member name="M:CliWrap.Cli.Wrap(System.String)">
  284. <summary>
  285. Creates a new command that targets the specified command-line executable, batch file, or script.
  286. </summary>
  287. </member>
  288. <member name="T:CliWrap.Command">
  289. <summary>
  290. Instructions for running a process.
  291. </summary>
  292. </member>
  293. <member name="M:CliWrap.Command.#ctor(System.String,System.String,System.String,CliWrap.ResourcePolicy,CliWrap.Credentials,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String},CliWrap.CommandResultValidation,CliWrap.PipeSource,CliWrap.PipeTarget,CliWrap.PipeTarget)">
  294. <summary>
  295. Instructions for running a process.
  296. </summary>
  297. </member>
  298. <member name="M:CliWrap.Command.#ctor(System.String)">
  299. <summary>
  300. Initializes an instance of <see cref="T:CliWrap.Command" />.
  301. </summary>
  302. </member>
  303. <member name="P:CliWrap.Command.TargetFilePath">
  304. <inheritdoc />
  305. </member>
  306. <member name="P:CliWrap.Command.Arguments">
  307. <inheritdoc />
  308. </member>
  309. <member name="P:CliWrap.Command.WorkingDirPath">
  310. <inheritdoc />
  311. </member>
  312. <member name="P:CliWrap.Command.ResourcePolicy">
  313. <inheritdoc />
  314. </member>
  315. <member name="P:CliWrap.Command.Credentials">
  316. <inheritdoc />
  317. </member>
  318. <member name="P:CliWrap.Command.EnvironmentVariables">
  319. <inheritdoc />
  320. </member>
  321. <member name="P:CliWrap.Command.Validation">
  322. <inheritdoc />
  323. </member>
  324. <member name="P:CliWrap.Command.StandardInputPipe">
  325. <inheritdoc />
  326. </member>
  327. <member name="P:CliWrap.Command.StandardOutputPipe">
  328. <inheritdoc />
  329. </member>
  330. <member name="P:CliWrap.Command.StandardErrorPipe">
  331. <inheritdoc />
  332. </member>
  333. <member name="M:CliWrap.Command.WithTargetFile(System.String)">
  334. <summary>
  335. Creates a copy of this command, setting the target file path to the specified value.
  336. </summary>
  337. </member>
  338. <member name="M:CliWrap.Command.WithArguments(System.String)">
  339. <summary>
  340. Creates a copy of this command, setting the arguments to the specified value.
  341. </summary>
  342. <remarks>
  343. Avoid using this overload, as it requires the arguments to be escaped manually.
  344. Formatting errors may lead to unexpected bugs and security vulnerabilities.
  345. </remarks>
  346. </member>
  347. <member name="M:CliWrap.Command.WithArguments(System.Collections.Generic.IEnumerable{System.String},System.Boolean)">
  348. <summary>
  349. Creates a copy of this command, setting the arguments to the value
  350. obtained by formatting the specified enumeration.
  351. </summary>
  352. </member>
  353. <member name="M:CliWrap.Command.WithArguments(System.Collections.Generic.IEnumerable{System.String})">
  354. <summary>
  355. Creates a copy of this command, setting the arguments to the value
  356. obtained by formatting the specified enumeration.
  357. </summary>
  358. </member>
  359. <member name="M:CliWrap.Command.WithArguments(System.Action{CliWrap.Builders.ArgumentsBuilder})">
  360. <summary>
  361. Creates a copy of this command, setting the arguments to the value
  362. configured by the specified delegate.
  363. </summary>
  364. </member>
  365. <member name="M:CliWrap.Command.WithWorkingDirectory(System.String)">
  366. <summary>
  367. Creates a copy of this command, setting the working directory path to the specified value.
  368. </summary>
  369. </member>
  370. <member name="M:CliWrap.Command.WithResourcePolicy(CliWrap.ResourcePolicy)">
  371. <summary>
  372. Creates a copy of this command, setting the resource policy to the specified value.
  373. </summary>
  374. </member>
  375. <member name="M:CliWrap.Command.WithResourcePolicy(System.Action{CliWrap.Builders.ResourcePolicyBuilder})">
  376. <summary>
  377. Creates a copy of this command, setting the resource policy to the value
  378. configured by the specified delegate.
  379. </summary>
  380. </member>
  381. <member name="M:CliWrap.Command.WithCredentials(CliWrap.Credentials)">
  382. <summary>
  383. Creates a copy of this command, setting the user credentials to the specified value.
  384. </summary>
  385. </member>
  386. <member name="M:CliWrap.Command.WithCredentials(System.Action{CliWrap.Builders.CredentialsBuilder})">
  387. <summary>
  388. Creates a copy of this command, setting the user credentials to the value
  389. configured by the specified delegate.
  390. </summary>
  391. </member>
  392. <member name="M:CliWrap.Command.WithEnvironmentVariables(System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})">
  393. <summary>
  394. Creates a copy of this command, setting the environment variables to the specified value.
  395. </summary>
  396. </member>
  397. <member name="M:CliWrap.Command.WithEnvironmentVariables(System.Action{CliWrap.Builders.EnvironmentVariablesBuilder})">
  398. <summary>
  399. Creates a copy of this command, setting the environment variables to the value
  400. configured by the specified delegate.
  401. </summary>
  402. </member>
  403. <member name="M:CliWrap.Command.WithValidation(CliWrap.CommandResultValidation)">
  404. <summary>
  405. Creates a copy of this command, setting the validation options to the specified value.
  406. </summary>
  407. </member>
  408. <member name="M:CliWrap.Command.WithStandardInputPipe(CliWrap.PipeSource)">
  409. <summary>
  410. Creates a copy of this command, setting the standard input pipe to the specified source.
  411. </summary>
  412. </member>
  413. <member name="M:CliWrap.Command.WithStandardOutputPipe(CliWrap.PipeTarget)">
  414. <summary>
  415. Creates a copy of this command, setting the standard output pipe to the specified target.
  416. </summary>
  417. </member>
  418. <member name="M:CliWrap.Command.WithStandardErrorPipe(CliWrap.PipeTarget)">
  419. <summary>
  420. Creates a copy of this command, setting the standard error pipe to the specified target.
  421. </summary>
  422. </member>
  423. <member name="M:CliWrap.Command.ToString">
  424. <inheritdoc />
  425. </member>
  426. <member name="M:CliWrap.Command.ExecuteAsync(System.Action{System.Diagnostics.ProcessStartInfo},System.Action{System.Diagnostics.Process},System.Threading.CancellationToken,System.Threading.CancellationToken)">
  427. <summary>
  428. Executes the command asynchronously.
  429. This overload allows you to directly configure the underlying process, and should
  430. only be used in rare cases when you need to break out of the abstraction model
  431. provided by CliWrap.
  432. This overload comes with no warranty and using it may lead to unexpected behavior.
  433. </summary>
  434. <remarks>
  435. This method can be awaited.
  436. </remarks>
  437. </member>
  438. <member name="M:CliWrap.Command.ExecuteAsync(System.Threading.CancellationToken,System.Threading.CancellationToken)">
  439. <summary>
  440. Executes the command asynchronously.
  441. </summary>
  442. <remarks>
  443. This method can be awaited.
  444. </remarks>
  445. </member>
  446. <member name="M:CliWrap.Command.ExecuteAsync(System.Threading.CancellationToken)">
  447. <summary>
  448. Executes the command asynchronously.
  449. </summary>
  450. <remarks>
  451. This method can be awaited.
  452. </remarks>
  453. </member>
  454. <member name="M:CliWrap.Command.op_BitwiseOr(CliWrap.Command,CliWrap.PipeTarget)">
  455. <summary>
  456. Creates a new command that pipes its standard output to the specified target.
  457. </summary>
  458. </member>
  459. <member name="M:CliWrap.Command.op_BitwiseOr(CliWrap.Command,System.IO.Stream)">
  460. <summary>
  461. Creates a new command that pipes its standard output to the specified stream.
  462. </summary>
  463. </member>
  464. <member name="M:CliWrap.Command.op_BitwiseOr(CliWrap.Command,System.Text.StringBuilder)">
  465. <summary>
  466. Creates a new command that pipes its standard output to the specified string builder.
  467. Uses <see cref="P:System.Text.Encoding.Default" /> for decoding.
  468. </summary>
  469. </member>
  470. <member name="M:CliWrap.Command.op_BitwiseOr(CliWrap.Command,System.Func{System.String,System.Threading.CancellationToken,System.Threading.Tasks.Task})">
  471. <summary>
  472. Creates a new command that pipes its standard output line-by-line to the specified
  473. asynchronous delegate.
  474. Uses <see cref="P:System.Text.Encoding.Default" /> for decoding.
  475. </summary>
  476. </member>
  477. <member name="M:CliWrap.Command.op_BitwiseOr(CliWrap.Command,System.Func{System.String,System.Threading.Tasks.Task})">
  478. <summary>
  479. Creates a new command that pipes its standard output line-by-line to the specified
  480. asynchronous delegate.
  481. Uses <see cref="P:System.Text.Encoding.Default" /> for decoding.
  482. </summary>
  483. </member>
  484. <member name="M:CliWrap.Command.op_BitwiseOr(CliWrap.Command,System.Action{System.String})">
  485. <summary>
  486. Creates a new command that pipes its standard output line-by-line to the specified
  487. synchronous delegate.
  488. Uses <see cref="P:System.Text.Encoding.Default" /> for decoding.
  489. </summary>
  490. </member>
  491. <member name="M:CliWrap.Command.op_BitwiseOr(CliWrap.Command,System.ValueTuple{CliWrap.PipeTarget,CliWrap.PipeTarget})">
  492. <summary>
  493. Creates a new command that pipes its standard output and standard error to the
  494. specified targets.
  495. </summary>
  496. </member>
  497. <member name="M:CliWrap.Command.op_BitwiseOr(CliWrap.Command,System.ValueTuple{System.IO.Stream,System.IO.Stream})">
  498. <summary>
  499. Creates a new command that pipes its standard output and standard error to the
  500. specified streams.
  501. </summary>
  502. </member>
  503. <member name="M:CliWrap.Command.op_BitwiseOr(CliWrap.Command,System.ValueTuple{System.Text.StringBuilder,System.Text.StringBuilder})">
  504. <summary>
  505. Creates a new command that pipes its standard output and standard error to the
  506. specified string builders.
  507. Uses <see cref="P:System.Text.Encoding.Default" /> for decoding.
  508. </summary>
  509. </member>
  510. <member name="M:CliWrap.Command.op_BitwiseOr(CliWrap.Command,System.ValueTuple{System.Func{System.String,System.Threading.CancellationToken,System.Threading.Tasks.Task},System.Func{System.String,System.Threading.CancellationToken,System.Threading.Tasks.Task}})">
  511. <summary>
  512. Creates a new command that pipes its standard output and standard error line-by-line
  513. to the specified asynchronous delegates.
  514. Uses <see cref="P:System.Text.Encoding.Default" /> for decoding.
  515. </summary>
  516. </member>
  517. <member name="M:CliWrap.Command.op_BitwiseOr(CliWrap.Command,System.ValueTuple{System.Func{System.String,System.Threading.Tasks.Task},System.Func{System.String,System.Threading.Tasks.Task}})">
  518. <summary>
  519. Creates a new command that pipes its standard output and standard error line-by-line
  520. to the specified asynchronous delegates.
  521. Uses <see cref="P:System.Text.Encoding.Default" /> for decoding.
  522. </summary>
  523. </member>
  524. <member name="M:CliWrap.Command.op_BitwiseOr(CliWrap.Command,System.ValueTuple{System.Action{System.String},System.Action{System.String}})">
  525. <summary>
  526. Creates a new command that pipes its standard output and standard error line-by-line
  527. to the specified synchronous delegates.
  528. Uses <see cref="P:System.Text.Encoding.Default" /> for decoding.
  529. </summary>
  530. </member>
  531. <member name="M:CliWrap.Command.op_BitwiseOr(CliWrap.PipeSource,CliWrap.Command)">
  532. <summary>
  533. Creates a new command that pipes its standard input from the specified source.
  534. </summary>
  535. </member>
  536. <member name="M:CliWrap.Command.op_BitwiseOr(System.IO.Stream,CliWrap.Command)">
  537. <summary>
  538. Creates a new command that pipes its standard input from the specified stream.
  539. </summary>
  540. </member>
  541. <member name="M:CliWrap.Command.op_BitwiseOr(System.ReadOnlyMemory{System.Byte},CliWrap.Command)">
  542. <summary>
  543. Creates a new command that pipes its standard input from the specified memory buffer.
  544. </summary>
  545. </member>
  546. <member name="M:CliWrap.Command.op_BitwiseOr(System.Byte[],CliWrap.Command)">
  547. <summary>
  548. Creates a new command that pipes its standard input from the specified byte array.
  549. </summary>
  550. </member>
  551. <member name="M:CliWrap.Command.op_BitwiseOr(System.String,CliWrap.Command)">
  552. <summary>
  553. Creates a new command that pipes its standard input from the specified string.
  554. Uses <see cref="P:System.Console.InputEncoding" /> for encoding.
  555. </summary>
  556. </member>
  557. <member name="M:CliWrap.Command.op_BitwiseOr(CliWrap.Command,CliWrap.Command)">
  558. <summary>
  559. Creates a new command that pipes its standard input from the standard output of the
  560. specified command.
  561. </summary>
  562. </member>
  563. <member name="T:CliWrap.CommandResult">
  564. <summary>
  565. Result of a command execution.
  566. </summary>
  567. </member>
  568. <member name="M:CliWrap.CommandResult.#ctor(System.Int32,System.DateTimeOffset,System.DateTimeOffset)">
  569. <summary>
  570. Result of a command execution.
  571. </summary>
  572. </member>
  573. <member name="P:CliWrap.CommandResult.ExitCode">
  574. <summary>
  575. Exit code set by the underlying process.
  576. </summary>
  577. </member>
  578. <member name="P:CliWrap.CommandResult.IsSuccess">
  579. <summary>
  580. Whether the command execution was successful (i.e. exit code is zero).
  581. </summary>
  582. </member>
  583. <member name="P:CliWrap.CommandResult.StartTime">
  584. <summary>
  585. Time at which the command started executing.
  586. </summary>
  587. </member>
  588. <member name="P:CliWrap.CommandResult.ExitTime">
  589. <summary>
  590. Time at which the command finished executing.
  591. </summary>
  592. </member>
  593. <member name="P:CliWrap.CommandResult.RunTime">
  594. <summary>
  595. Total duration of the command execution.
  596. </summary>
  597. </member>
  598. <member name="T:CliWrap.CommandResultValidation">
  599. <summary>
  600. Strategy used for validating the result of a command execution.
  601. </summary>
  602. </member>
  603. <member name="F:CliWrap.CommandResultValidation.None">
  604. <summary>
  605. No validation.
  606. </summary>
  607. </member>
  608. <member name="F:CliWrap.CommandResultValidation.ZeroExitCode">
  609. <summary>
  610. Ensure that the command returned a zero exit code.
  611. </summary>
  612. </member>
  613. <member name="T:CliWrap.CommandTask`1">
  614. <summary>
  615. Represents an asynchronous execution of a command.
  616. </summary>
  617. </member>
  618. <member name="M:CliWrap.CommandTask`1.#ctor(System.Threading.Tasks.Task{`0},System.Int32)">
  619. <summary>
  620. Represents an asynchronous execution of a command.
  621. </summary>
  622. </member>
  623. <member name="P:CliWrap.CommandTask`1.Task">
  624. <summary>
  625. Underlying task.
  626. </summary>
  627. </member>
  628. <member name="P:CliWrap.CommandTask`1.ProcessId">
  629. <summary>
  630. Underlying process ID.
  631. </summary>
  632. </member>
  633. <member name="M:CliWrap.CommandTask`1.Select``1(System.Func{`0,``0})">
  634. <summary>
  635. Lazily maps the result of the task using the specified transform.
  636. </summary>
  637. </member>
  638. <member name="M:CliWrap.CommandTask`1.GetAwaiter">
  639. <summary>
  640. Gets the awaiter of the underlying task.
  641. Used to enable await expressions on this object.
  642. </summary>
  643. </member>
  644. <member name="M:CliWrap.CommandTask`1.ConfigureAwait(System.Boolean)">
  645. <summary>
  646. Configures an awaiter used to await this task.
  647. </summary>
  648. </member>
  649. <member name="M:CliWrap.CommandTask`1.Dispose">
  650. <inheritdoc />
  651. </member>
  652. <member name="M:CliWrap.CommandTask`1.op_Implicit(CliWrap.CommandTask{`0})~System.Threading.Tasks.Task{`0}">
  653. <summary>
  654. Converts the command task into a regular task.
  655. </summary>
  656. </member>
  657. <member name="T:CliWrap.Credentials">
  658. <summary>
  659. User credentials used for starting a process.
  660. </summary>
  661. <remarks>
  662. For information on platform support, see attributes on <see cref="P:System.Diagnostics.ProcessStartInfo.Domain" />,
  663. <see cref="P:System.Diagnostics.ProcessStartInfo.UserName" />, <see cref="P:System.Diagnostics.ProcessStartInfo.Password" /> and
  664. <see cref="P:System.Diagnostics.ProcessStartInfo.LoadUserProfile" />.
  665. </remarks>
  666. </member>
  667. <member name="M:CliWrap.Credentials.#ctor(System.String,System.String,System.String,System.Boolean)">
  668. <summary>
  669. User credentials used for starting a process.
  670. </summary>
  671. <remarks>
  672. For information on platform support, see attributes on <see cref="P:System.Diagnostics.ProcessStartInfo.Domain" />,
  673. <see cref="P:System.Diagnostics.ProcessStartInfo.UserName" />, <see cref="P:System.Diagnostics.ProcessStartInfo.Password" /> and
  674. <see cref="P:System.Diagnostics.ProcessStartInfo.LoadUserProfile" />.
  675. </remarks>
  676. </member>
  677. <member name="M:CliWrap.Credentials.#ctor(System.String,System.String,System.String)">
  678. <summary>
  679. Initializes an instance of <see cref="T:CliWrap.Credentials" />.
  680. </summary>
  681. </member>
  682. <member name="P:CliWrap.Credentials.Domain">
  683. <summary>
  684. Active Directory domain used for starting the process.
  685. </summary>
  686. <remarks>
  687. Only supported on Windows.
  688. </remarks>
  689. </member>
  690. <member name="P:CliWrap.Credentials.UserName">
  691. <summary>
  692. Username used for starting the process.
  693. </summary>
  694. </member>
  695. <member name="P:CliWrap.Credentials.Password">
  696. <summary>
  697. Password used for starting the process.
  698. </summary>
  699. <remarks>
  700. Only supported on Windows.
  701. </remarks>
  702. </member>
  703. <member name="P:CliWrap.Credentials.LoadUserProfile">
  704. <summary>
  705. Whether to load the user profile when starting the process.
  706. </summary>
  707. <remarks>
  708. Only supported on Windows.
  709. </remarks>
  710. </member>
  711. <member name="P:CliWrap.Credentials.Default">
  712. <summary>
  713. Empty credentials.
  714. </summary>
  715. </member>
  716. <member name="T:CliWrap.EventStream.CommandEvent">
  717. <summary>
  718. <para>
  719. Abstract event produced by a command.
  720. Use pattern matching to handle specific instances of this type.
  721. </para>
  722. <para>
  723. Can be either one of the following:
  724. <list type="bullet">
  725. <item><see cref="T:CliWrap.EventStream.StartedCommandEvent" /></item>
  726. <item><see cref="T:CliWrap.EventStream.StandardOutputCommandEvent" /></item>
  727. <item><see cref="T:CliWrap.EventStream.StandardErrorCommandEvent" /></item>
  728. <item><see cref="T:CliWrap.EventStream.ExitedCommandEvent" /></item>
  729. </list>
  730. </para>
  731. </summary>
  732. </member>
  733. <member name="T:CliWrap.EventStream.StartedCommandEvent">
  734. <summary>
  735. Event triggered when the command starts executing.
  736. May only appear once in the event stream.
  737. </summary>
  738. </member>
  739. <member name="M:CliWrap.EventStream.StartedCommandEvent.#ctor(System.Int32)">
  740. <summary>
  741. Event triggered when the command starts executing.
  742. May only appear once in the event stream.
  743. </summary>
  744. </member>
  745. <member name="P:CliWrap.EventStream.StartedCommandEvent.ProcessId">
  746. <summary>
  747. Underlying process ID.
  748. </summary>
  749. </member>
  750. <member name="M:CliWrap.EventStream.StartedCommandEvent.ToString">
  751. <inheritdoc />
  752. </member>
  753. <member name="T:CliWrap.EventStream.StandardOutputCommandEvent">
  754. <summary>
  755. Event triggered when the underlying process writes a line of text to the standard output stream.
  756. </summary>
  757. </member>
  758. <member name="M:CliWrap.EventStream.StandardOutputCommandEvent.#ctor(System.String)">
  759. <summary>
  760. Event triggered when the underlying process writes a line of text to the standard output stream.
  761. </summary>
  762. </member>
  763. <member name="P:CliWrap.EventStream.StandardOutputCommandEvent.Text">
  764. <summary>
  765. Line of text written to the standard output stream.
  766. </summary>
  767. </member>
  768. <member name="M:CliWrap.EventStream.StandardOutputCommandEvent.ToString">
  769. <inheritdoc />
  770. </member>
  771. <member name="T:CliWrap.EventStream.StandardErrorCommandEvent">
  772. <summary>
  773. Event triggered when the underlying process writes a line of text to the standard error stream.
  774. </summary>
  775. </member>
  776. <member name="M:CliWrap.EventStream.StandardErrorCommandEvent.#ctor(System.String)">
  777. <summary>
  778. Event triggered when the underlying process writes a line of text to the standard error stream.
  779. </summary>
  780. </member>
  781. <member name="P:CliWrap.EventStream.StandardErrorCommandEvent.Text">
  782. <summary>
  783. Line of text written to the standard error stream.
  784. </summary>
  785. </member>
  786. <member name="M:CliWrap.EventStream.StandardErrorCommandEvent.ToString">
  787. <inheritdoc />
  788. </member>
  789. <member name="T:CliWrap.EventStream.ExitedCommandEvent">
  790. <summary>
  791. Event triggered when the command finishes executing.
  792. May only appear once in the event stream.
  793. </summary>
  794. </member>
  795. <member name="M:CliWrap.EventStream.ExitedCommandEvent.#ctor(System.Int32)">
  796. <summary>
  797. Event triggered when the command finishes executing.
  798. May only appear once in the event stream.
  799. </summary>
  800. </member>
  801. <member name="P:CliWrap.EventStream.ExitedCommandEvent.ExitCode">
  802. <summary>
  803. Exit code set by the underlying process.
  804. </summary>
  805. </member>
  806. <member name="M:CliWrap.EventStream.ExitedCommandEvent.ToString">
  807. <inheritdoc />
  808. </member>
  809. <member name="T:CliWrap.EventStream.EventStreamCommandExtensions">
  810. <summary>
  811. Event stream execution model.
  812. </summary>
  813. <summary>
  814. Event stream execution model.
  815. </summary>
  816. </member>
  817. <member name="M:CliWrap.EventStream.EventStreamCommandExtensions.ListenAsync(CliWrap.Command,System.Text.Encoding,System.Text.Encoding,System.Threading.CancellationToken,System.Threading.CancellationToken)">
  818. <summary>
  819. Executes the command as a pull-based event stream.
  820. </summary>
  821. <remarks>
  822. Use pattern matching to handle specific instances of <see cref="T:CliWrap.EventStream.CommandEvent" />.
  823. </remarks>
  824. </member>
  825. <member name="M:CliWrap.EventStream.EventStreamCommandExtensions.ListenAsync(CliWrap.Command,System.Text.Encoding,System.Text.Encoding,System.Threading.CancellationToken)">
  826. <summary>
  827. Executes the command as a pull-based event stream.
  828. </summary>
  829. <remarks>
  830. Use pattern matching to handle specific instances of <see cref="T:CliWrap.EventStream.CommandEvent" />.
  831. </remarks>
  832. </member>
  833. <member name="M:CliWrap.EventStream.EventStreamCommandExtensions.ListenAsync(CliWrap.Command,System.Text.Encoding,System.Threading.CancellationToken)">
  834. <summary>
  835. Executes the command as a pull-based event stream.
  836. </summary>
  837. <remarks>
  838. Use pattern matching to handle specific instances of <see cref="T:CliWrap.EventStream.CommandEvent" />.
  839. </remarks>
  840. </member>
  841. <member name="M:CliWrap.EventStream.EventStreamCommandExtensions.ListenAsync(CliWrap.Command,System.Threading.CancellationToken)">
  842. <summary>
  843. Executes the command as a pull-based event stream.
  844. Uses <see cref="P:System.Text.Encoding.Default" /> for decoding.
  845. </summary>
  846. <remarks>
  847. Use pattern matching to handle specific instances of <see cref="T:CliWrap.EventStream.CommandEvent" />.
  848. </remarks>
  849. </member>
  850. <member name="M:CliWrap.EventStream.EventStreamCommandExtensions.Observe(CliWrap.Command,System.Text.Encoding,System.Text.Encoding,System.Threading.CancellationToken,System.Threading.CancellationToken)">
  851. <summary>
  852. Executes the command as a push-based event stream.
  853. </summary>
  854. <remarks>
  855. Use pattern matching to handle specific instances of <see cref="T:CliWrap.EventStream.CommandEvent" />.
  856. </remarks>
  857. </member>
  858. <member name="M:CliWrap.EventStream.EventStreamCommandExtensions.Observe(CliWrap.Command,System.Text.Encoding,System.Text.Encoding,System.Threading.CancellationToken)">
  859. <summary>
  860. Executes the command as a push-based event stream.
  861. </summary>
  862. <remarks>
  863. Use pattern matching to handle specific instances of <see cref="T:CliWrap.EventStream.CommandEvent" />.
  864. </remarks>
  865. </member>
  866. <member name="M:CliWrap.EventStream.EventStreamCommandExtensions.Observe(CliWrap.Command,System.Text.Encoding,System.Threading.CancellationToken)">
  867. <summary>
  868. Executes the command as a push-based event stream.
  869. </summary>
  870. <remarks>
  871. Use pattern matching to handle specific instances of <see cref="T:CliWrap.EventStream.CommandEvent" />.
  872. </remarks>
  873. </member>
  874. <member name="M:CliWrap.EventStream.EventStreamCommandExtensions.Observe(CliWrap.Command,System.Threading.CancellationToken)">
  875. <summary>
  876. Executes the command as a push-based event stream.
  877. Uses <see cref="P:System.Text.Encoding.Default" /> for decoding.
  878. </summary>
  879. <remarks>
  880. Use pattern matching to handle specific instances of <see cref="T:CliWrap.EventStream.CommandEvent" />.
  881. </remarks>
  882. </member>
  883. <member name="T:CliWrap.Exceptions.CliWrapException">
  884. <summary>
  885. Parent class for exceptions thrown by <see cref="N:CliWrap" />.
  886. </summary>
  887. </member>
  888. <member name="M:CliWrap.Exceptions.CliWrapException.#ctor(System.String,System.Exception)">
  889. <summary>
  890. Parent class for exceptions thrown by <see cref="N:CliWrap" />.
  891. </summary>
  892. </member>
  893. <member name="M:CliWrap.Exceptions.CliWrapException.#ctor(System.String)">
  894. <summary>
  895. Initializes an instance of <see cref="T:CliWrap.Exceptions.CliWrapException" />.
  896. </summary>
  897. </member>
  898. <member name="T:CliWrap.Exceptions.CommandExecutionException">
  899. <summary>
  900. Exception thrown when the command fails to execute correctly.
  901. </summary>
  902. </member>
  903. <member name="M:CliWrap.Exceptions.CommandExecutionException.#ctor(CliWrap.ICommandConfiguration,System.Int32,System.String,System.Exception)">
  904. <summary>
  905. Exception thrown when the command fails to execute correctly.
  906. </summary>
  907. </member>
  908. <member name="M:CliWrap.Exceptions.CommandExecutionException.#ctor(CliWrap.ICommandConfiguration,System.Int32,System.String)">
  909. <summary>
  910. Initializes an instance of <see cref="T:CliWrap.Exceptions.CommandExecutionException" />.
  911. </summary>
  912. </member>
  913. <member name="P:CliWrap.Exceptions.CommandExecutionException.Command">
  914. <summary>
  915. Command that triggered the exception.
  916. </summary>
  917. </member>
  918. <member name="P:CliWrap.Exceptions.CommandExecutionException.ExitCode">
  919. <summary>
  920. Exit code returned by the process.
  921. </summary>
  922. </member>
  923. <member name="T:CliWrap.ICommandConfiguration">
  924. <summary>
  925. Instructions for running a process.
  926. </summary>
  927. </member>
  928. <member name="P:CliWrap.ICommandConfiguration.TargetFilePath">
  929. <summary>
  930. File path of the executable, batch file, or script, that this command runs.
  931. </summary>
  932. </member>
  933. <member name="P:CliWrap.ICommandConfiguration.Arguments">
  934. <summary>
  935. Command-line arguments passed to the underlying process.
  936. </summary>
  937. </member>
  938. <member name="P:CliWrap.ICommandConfiguration.WorkingDirPath">
  939. <summary>
  940. Working directory path set for the underlying process.
  941. </summary>
  942. </member>
  943. <member name="P:CliWrap.ICommandConfiguration.ResourcePolicy">
  944. <summary>
  945. Resource policy set for the underlying process.
  946. </summary>
  947. </member>
  948. <member name="P:CliWrap.ICommandConfiguration.Credentials">
  949. <summary>
  950. User credentials set for the underlying process.
  951. </summary>
  952. </member>
  953. <member name="P:CliWrap.ICommandConfiguration.EnvironmentVariables">
  954. <summary>
  955. Environment variables set for the underlying process.
  956. </summary>
  957. </member>
  958. <member name="P:CliWrap.ICommandConfiguration.Validation">
  959. <summary>
  960. Strategy for validating the result of the execution.
  961. </summary>
  962. </member>
  963. <member name="P:CliWrap.ICommandConfiguration.StandardInputPipe">
  964. <summary>
  965. Pipe source for the standard input stream of the underlying process.
  966. </summary>
  967. </member>
  968. <member name="P:CliWrap.ICommandConfiguration.StandardOutputPipe">
  969. <summary>
  970. Pipe target for the standard output stream of the underlying process.
  971. </summary>
  972. </member>
  973. <member name="P:CliWrap.ICommandConfiguration.StandardErrorPipe">
  974. <summary>
  975. Pipe target for the standard error stream of the underlying process.
  976. </summary>
  977. </member>
  978. <member name="T:CliWrap.PipeSource">
  979. <summary>
  980. Represents a pipe for the process's standard input stream.
  981. </summary>
  982. </member>
  983. <member name="M:CliWrap.PipeSource.CopyToAsync(System.IO.Stream,System.Threading.CancellationToken)">
  984. <summary>
  985. Reads the binary content pushed into the pipe and writes it to the destination stream.
  986. Destination stream represents the process's standard input stream.
  987. </summary>
  988. </member>
  989. <member name="P:CliWrap.PipeSource.Null">
  990. <summary>
  991. Pipe source that does not provide any data.
  992. Functionally equivalent to a null device.
  993. </summary>
  994. </member>
  995. <member name="M:CliWrap.PipeSource.Create(System.Func{System.IO.Stream,System.Threading.CancellationToken,System.Threading.Tasks.Task})">
  996. <summary>
  997. Creates an anonymous pipe source with the <see cref="M:CliWrap.PipeSource.CopyToAsync(System.IO.Stream,System.Threading.CancellationToken)" /> method
  998. implemented by the specified asynchronous delegate.
  999. </summary>
  1000. </member>
  1001. <member name="M:CliWrap.PipeSource.Create(System.Action{System.IO.Stream})">
  1002. <summary>
  1003. Creates an anonymous pipe source with the <see cref="M:CliWrap.PipeSource.CopyToAsync(System.IO.Stream,System.Threading.CancellationToken)" /> method
  1004. implemented by the specified synchronous delegate.
  1005. </summary>
  1006. </member>
  1007. <member name="M:CliWrap.PipeSource.FromStream(System.IO.Stream,System.Boolean)">
  1008. <summary>
  1009. Creates a pipe source that reads from the specified stream.
  1010. </summary>
  1011. </member>
  1012. <member name="M:CliWrap.PipeSource.FromStream(System.IO.Stream)">
  1013. <summary>
  1014. Creates a pipe source that reads from the specified stream.
  1015. </summary>
  1016. </member>
  1017. <member name="M:CliWrap.PipeSource.FromFile(System.String)">
  1018. <summary>
  1019. Creates a pipe source that reads from the specified file.
  1020. </summary>
  1021. </member>
  1022. <member name="M:CliWrap.PipeSource.FromBytes(System.ReadOnlyMemory{System.Byte})">
  1023. <summary>
  1024. Creates a pipe source that reads from the specified memory buffer.
  1025. </summary>
  1026. </member>
  1027. <member name="M:CliWrap.PipeSource.FromBytes(System.Byte[])">
  1028. <summary>
  1029. Creates a pipe source that reads from the specified byte array.
  1030. </summary>
  1031. </member>
  1032. <member name="M:CliWrap.PipeSource.FromMemory(System.ReadOnlyMemory{System.Byte})">
  1033. <inheritdoc cref="M:CliWrap.PipeSource.FromBytes(System.ReadOnlyMemory{System.Byte})" />
  1034. </member>
  1035. <member name="M:CliWrap.PipeSource.FromString(System.String,System.Text.Encoding)">
  1036. <summary>
  1037. Creates a pipe source that reads from the specified string.
  1038. </summary>
  1039. </member>
  1040. <member name="M:CliWrap.PipeSource.FromString(System.String)">
  1041. <summary>
  1042. Creates a pipe source that reads from the specified string.
  1043. Uses <see cref="P:System.Console.InputEncoding" /> for encoding.
  1044. </summary>
  1045. </member>
  1046. <member name="M:CliWrap.PipeSource.FromCommand(CliWrap.Command,System.Func{System.IO.Stream,System.IO.Stream,System.Threading.CancellationToken,System.Threading.Tasks.Task})">
  1047. <summary>
  1048. Creates a pipe source that reads from the standard output of the specified command.
  1049. </summary>
  1050. </member>
  1051. <member name="M:CliWrap.PipeSource.FromCommand(CliWrap.Command)">
  1052. <summary>
  1053. Creates a pipe source that reads from the standard output of the specified command.
  1054. </summary>
  1055. </member>
  1056. <member name="T:CliWrap.PipeTarget">
  1057. <summary>
  1058. Represents a pipe for the process's standard output or standard error stream.
  1059. </summary>
  1060. </member>
  1061. <member name="M:CliWrap.PipeTarget.CopyFromAsync(System.IO.Stream,System.Threading.CancellationToken)">
  1062. <summary>
  1063. Reads the binary content from the origin stream and pushes it into the pipe.
  1064. Origin stream represents the process's standard output or standard error stream.
  1065. </summary>
  1066. </member>
  1067. <member name="P:CliWrap.PipeTarget.Null">
  1068. <summary>
  1069. Pipe target that discards all data.
  1070. Functionally equivalent to a null device.
  1071. </summary>
  1072. <remarks>
  1073. Using this target results in the corresponding stream (standard output or standard error)
  1074. not being opened for the underlying process at all.
  1075. In the vast majority of cases, this behavior should be functionally equivalent to piping
  1076. to a null stream, but without the performance overhead of consuming and discarding unneeded data.
  1077. This may be undesirable in certain situations, in which case it's recommended to pipe to a
  1078. null stream explicitly using <see cref="M:CliWrap.PipeTarget.ToStream(System.IO.Stream)" /> with <see cref="F:System.IO.Stream.Null" />.
  1079. </remarks>
  1080. </member>
  1081. <member name="M:CliWrap.PipeTarget.Create(System.Func{System.IO.Stream,System.Threading.CancellationToken,System.Threading.Tasks.Task})">
  1082. <summary>
  1083. Creates an anonymous pipe target with the <see cref="M:CliWrap.PipeTarget.CopyFromAsync(System.IO.Stream,System.Threading.CancellationToken)" /> method
  1084. implemented by the specified asynchronous delegate.
  1085. </summary>
  1086. </member>
  1087. <member name="M:CliWrap.PipeTarget.Create(System.Action{System.IO.Stream})">
  1088. <summary>
  1089. Creates an anonymous pipe target with the <see cref="M:CliWrap.PipeTarget.CopyFromAsync(System.IO.Stream,System.Threading.CancellationToken)" /> method
  1090. implemented by the specified synchronous delegate.
  1091. </summary>
  1092. </member>
  1093. <member name="M:CliWrap.PipeTarget.ToStream(System.IO.Stream,System.Boolean)">
  1094. <summary>
  1095. Creates a pipe target that writes to the specified stream.
  1096. </summary>
  1097. </member>
  1098. <member name="M:CliWrap.PipeTarget.ToStream(System.IO.Stream)">
  1099. <summary>
  1100. Creates a pipe target that writes to the specified stream.
  1101. </summary>
  1102. </member>
  1103. <member name="M:CliWrap.PipeTarget.ToFile(System.String)">
  1104. <summary>
  1105. Creates a pipe target that writes to the specified file.
  1106. </summary>
  1107. </member>
  1108. <member name="M:CliWrap.PipeTarget.ToStringBuilder(System.Text.StringBuilder,System.Text.Encoding)">
  1109. <summary>
  1110. Creates a pipe target that writes to the specified string builder.
  1111. </summary>
  1112. </member>
  1113. <member name="M:CliWrap.PipeTarget.ToStringBuilder(System.Text.StringBuilder)">
  1114. <summary>
  1115. Creates a pipe target that writes to the specified string builder.
  1116. Uses <see cref="P:System.Text.Encoding.Default" /> for decoding.
  1117. </summary>
  1118. </member>
  1119. <member name="M:CliWrap.PipeTarget.ToDelegate(System.Func{System.String,System.Threading.CancellationToken,System.Threading.Tasks.Task},System.Text.Encoding)">
  1120. <summary>
  1121. Creates a pipe target that invokes the specified asynchronous delegate on every line written to the stream.
  1122. </summary>
  1123. </member>
  1124. <member name="M:CliWrap.PipeTarget.ToDelegate(System.Func{System.String,System.Threading.CancellationToken,System.Threading.Tasks.Task})">
  1125. <summary>
  1126. Creates a pipe target that invokes the specified asynchronous delegate on every line written to the stream.
  1127. Uses <see cref="P:System.Text.Encoding.Default" /> for decoding.
  1128. </summary>
  1129. </member>
  1130. <member name="M:CliWrap.PipeTarget.ToDelegate(System.Func{System.String,System.Threading.Tasks.Task},System.Text.Encoding)">
  1131. <summary>
  1132. Creates a pipe target that invokes the specified asynchronous delegate on every line written to the stream.
  1133. </summary>
  1134. </member>
  1135. <member name="M:CliWrap.PipeTarget.ToDelegate(System.Func{System.String,System.Threading.Tasks.Task})">
  1136. <summary>
  1137. Creates a pipe target that invokes the specified asynchronous delegate on every line written to the stream.
  1138. Uses <see cref="P:System.Text.Encoding.Default" /> for decoding.
  1139. </summary>
  1140. </member>
  1141. <member name="M:CliWrap.PipeTarget.ToDelegate(System.Action{System.String},System.Text.Encoding)">
  1142. <summary>
  1143. Creates a pipe target that invokes the specified synchronous delegate on every line written to the stream.
  1144. </summary>
  1145. </member>
  1146. <member name="M:CliWrap.PipeTarget.ToDelegate(System.Action{System.String})">
  1147. <summary>
  1148. Creates a pipe target that invokes the specified synchronous delegate on every line written to the stream.
  1149. Uses <see cref="P:System.Text.Encoding.Default" /> for decoding.
  1150. </summary>
  1151. </member>
  1152. <member name="M:CliWrap.PipeTarget.Merge(System.Collections.Generic.IEnumerable{CliWrap.PipeTarget})">
  1153. <summary>
  1154. Creates a pipe target that replicates data over multiple inner targets.
  1155. </summary>
  1156. </member>
  1157. <member name="M:CliWrap.PipeTarget.Merge(CliWrap.PipeTarget[])">
  1158. <summary>
  1159. Creates a pipe target that replicates data over multiple inner targets.
  1160. </summary>
  1161. </member>
  1162. <member name="T:CliWrap.ResourcePolicy">
  1163. <summary>
  1164. Resource policy assigned to a process.
  1165. </summary>
  1166. <remarks>
  1167. For information on platform support, see attributes on <see cref="P:System.Diagnostics.Process.PriorityClass" />,
  1168. <see cref="P:System.Diagnostics.Process.ProcessorAffinity" />, <see cref="P:System.Diagnostics.Process.MinWorkingSet" /> and
  1169. <see cref="P:System.Diagnostics.Process.MaxWorkingSet" />.
  1170. </remarks>
  1171. </member>
  1172. <member name="M:CliWrap.ResourcePolicy.#ctor(System.Nullable{System.Diagnostics.ProcessPriorityClass},System.Nullable{System.IntPtr},System.Nullable{System.IntPtr},System.Nullable{System.IntPtr})">
  1173. <summary>
  1174. Resource policy assigned to a process.
  1175. </summary>
  1176. <remarks>
  1177. For information on platform support, see attributes on <see cref="P:System.Diagnostics.Process.PriorityClass" />,
  1178. <see cref="P:System.Diagnostics.Process.ProcessorAffinity" />, <see cref="P:System.Diagnostics.Process.MinWorkingSet" /> and
  1179. <see cref="P:System.Diagnostics.Process.MaxWorkingSet" />.
  1180. </remarks>
  1181. </member>
  1182. <member name="P:CliWrap.ResourcePolicy.Priority">
  1183. <summary>
  1184. Priority class of the process.
  1185. </summary>
  1186. </member>
  1187. <member name="P:CliWrap.ResourcePolicy.Affinity">
  1188. <summary>
  1189. Processor core affinity mask of the process.
  1190. </summary>
  1191. </member>
  1192. <member name="P:CliWrap.ResourcePolicy.MinWorkingSet">
  1193. <summary>
  1194. Minimum working set size of the process.
  1195. </summary>
  1196. </member>
  1197. <member name="P:CliWrap.ResourcePolicy.MaxWorkingSet">
  1198. <summary>
  1199. Maximum working set size of the process.
  1200. </summary>
  1201. </member>
  1202. <member name="P:CliWrap.ResourcePolicy.Default">
  1203. <summary>
  1204. Default resource policy.
  1205. </summary>
  1206. </member>
  1207. </members>
  1208. </doc>