-
Notifications
You must be signed in to change notification settings - Fork 13
/
FileSetStream.xml
371 lines (371 loc) · 18.6 KB
/
FileSetStream.xml
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
<Type Name="FileSetStream" FullName="Iot.Device.Common.FileSetStream">
<TypeSignature Language="C#" Value="public class FileSetStream : System.IO.Stream" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit FileSetStream extends System.IO.Stream" />
<TypeSignature Language="DocId" Value="T:Iot.Device.Common.FileSetStream" />
<TypeSignature Language="VB.NET" Value="Public Class FileSetStream
Inherits Stream" />
<TypeSignature Language="F#" Value="type FileSetStream = class
 inherit Stream" />
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.IO.Stream</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
A stream that combines a set of files. Can be used to read from a consecutive
list of files, e.g. log files that are split by size or date.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FileSetStream (System.Collections.Generic.IEnumerable<string> fileNames);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IEnumerable`1<string> fileNames) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.Common.FileSetStream.#ctor(System.Collections.Generic.IEnumerable{System.String})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (fileNames As IEnumerable(Of String))" />
<MemberSignature Language="F#" Value="new Iot.Device.Common.FileSetStream : seq<string> -> Iot.Device.Common.FileSetStream" Usage="new Iot.Device.Common.FileSetStream fileNames" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="fileNames" Type="System.Collections.Generic.IEnumerable<System.String>" />
</Parameters>
<Docs>
<param name="fileNames">A list of file names</param>
<summary>
Create a new instance using a set of files.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.IO.FileNotFoundException">One of the files doesn't exist</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FileSetStream (System.Collections.Generic.IEnumerable<(string FileName, System.IO.Stream? Alternate)> files);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IEnumerable`1<valuetype System.ValueTuple`2<string, class System.IO.Stream>> files) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.Common.FileSetStream.#ctor(System.Collections.Generic.IEnumerable{System.ValueTuple{System.String,System.IO.Stream}})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (files As IEnumerable(Of ValueTuple(Of String, Stream)))" />
<MemberSignature Language="F#" Value="new Iot.Device.Common.FileSetStream : seq<ValueTuple<string, System.IO.Stream>> -> Iot.Device.Common.FileSetStream" Usage="new Iot.Device.Common.FileSetStream files" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="files" Type="System.Collections.Generic.IEnumerable<System.ValueTuple<System.String,System.IO.Stream>>">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.TupleElementNames(new System.String[] { "FileName", "Alternate" })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.TupleElementNames(new System.String[] { "FileName", "Alternate" })>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="files">A list of file names or streams. If the stream of a pair is non-null, it is used instead of the name</param>
<summary>
Create a new instance using a set of files.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.IO.FileNotFoundException">One of the files doesn't exist</exception>
<exception cref="T:System.InvalidOperationException">A stream was provided that is not readable</exception>
</Docs>
</Member>
<Member MemberName="CanRead">
<MemberSignature Language="C#" Value="public override bool CanRead { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanRead" />
<MemberSignature Language="DocId" Value="P:Iot.Device.Common.FileSetStream.CanRead" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property CanRead As Boolean" />
<MemberSignature Language="F#" Value="member this.CanRead : bool" Usage="Iot.Device.Common.FileSetStream.CanRead" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
This returns true.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CanSeek">
<MemberSignature Language="C#" Value="public override bool CanSeek { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanSeek" />
<MemberSignature Language="DocId" Value="P:Iot.Device.Common.FileSetStream.CanSeek" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property CanSeek As Boolean" />
<MemberSignature Language="F#" Value="member this.CanSeek : bool" Usage="Iot.Device.Common.FileSetStream.CanSeek" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
This returns false.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CanWrite">
<MemberSignature Language="C#" Value="public override bool CanWrite { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanWrite" />
<MemberSignature Language="DocId" Value="P:Iot.Device.Common.FileSetStream.CanWrite" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property CanWrite As Boolean" />
<MemberSignature Language="F#" Value="member this.CanWrite : bool" Usage="Iot.Device.Common.FileSetStream.CanWrite" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
This returns false.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Dispose(bool disposing) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.Common.FileSetStream.Dispose(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub Dispose (disposing As Boolean)" />
<MemberSignature Language="F#" Value="override this.Dispose : bool -> unit" Usage="fileSetStream.Dispose disposing" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Flush">
<MemberSignature Language="C#" Value="public override void Flush ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Flush() cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.Common.FileSetStream.Flush" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Flush ()" />
<MemberSignature Language="F#" Value="override this.Flush : unit -> unit" Usage="fileSetStream.Flush " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
This does nothing
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Length">
<MemberSignature Language="C#" Value="public override long Length { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 Length" />
<MemberSignature Language="DocId" Value="P:Iot.Device.Common.FileSetStream.Length" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property Length As Long" />
<MemberSignature Language="F#" Value="member this.Length : int64" Usage="Iot.Device.Common.FileSetStream.Length" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
This is not supported
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Loop">
<MemberSignature Language="C#" Value="public bool Loop { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Loop" />
<MemberSignature Language="DocId" Value="P:Iot.Device.Common.FileSetStream.Loop" />
<MemberSignature Language="VB.NET" Value="Public Property Loop As Boolean" />
<MemberSignature Language="F#" Value="member this.Loop : bool with get, set" Usage="Iot.Device.Common.FileSetStream.Loop" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
True to indicate that reading should restart at the beginning when the list ends.
</summary>
<value>To be added.</value>
<remarks>
If this is true, the stream has no end, and reading will always succeed (unless
the file list is empty)
</remarks>
</Docs>
</Member>
<Member MemberName="Position">
<MemberSignature Language="C#" Value="public override long Position { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 Position" />
<MemberSignature Language="DocId" Value="P:Iot.Device.Common.FileSetStream.Position" />
<MemberSignature Language="VB.NET" Value="Public Overrides Property Position As Long" />
<MemberSignature Language="F#" Value="member this.Position : int64 with get, set" Usage="Iot.Device.Common.FileSetStream.Position" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
This is not supported
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Read">
<MemberSignature Language="C#" Value="public override int Read (byte[] buffer, int offset, int count);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 Read(unsigned int8[] buffer, int32 offset, int32 count) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.Common.FileSetStream.Read(System.Byte[],System.Int32,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Read (buffer As Byte(), offset As Integer, count As Integer) As Integer" />
<MemberSignature Language="F#" Value="override this.Read : byte[] * int * int -> int" Usage="fileSetStream.Read (buffer, offset, count)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<param name="buffer">Buffer to fill</param>
<param name="offset">Offset to start filling the buffer</param>
<param name="count">Maximum number of bytes to read.</param>
<summary>
Reads data from the stream.
</summary>
<returns>The number of bytes actually read</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Seek">
<MemberSignature Language="C#" Value="public override long Seek (long offset, System.IO.SeekOrigin origin);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int64 Seek(int64 offset, valuetype System.IO.SeekOrigin origin) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.Common.FileSetStream.Seek(System.Int64,System.IO.SeekOrigin)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Seek (offset As Long, origin As SeekOrigin) As Long" />
<MemberSignature Language="F#" Value="override this.Seek : int64 * System.IO.SeekOrigin -> int64" Usage="fileSetStream.Seek (offset, origin)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="offset" Type="System.Int64" />
<Parameter Name="origin" Type="System.IO.SeekOrigin" />
</Parameters>
<Docs>
<param name="offset">To be added.</param>
<param name="origin">To be added.</param>
<summary>
This operation is unsupported.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetLength">
<MemberSignature Language="C#" Value="public override void SetLength (long value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void SetLength(int64 value) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.Common.FileSetStream.SetLength(System.Int64)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub SetLength (value As Long)" />
<MemberSignature Language="F#" Value="override this.SetLength : int64 -> unit" Usage="fileSetStream.SetLength value" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Int64" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>
This operation is unsupported.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Write">
<MemberSignature Language="C#" Value="public override void Write (byte[] buffer, int offset, int count);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Write(unsigned int8[] buffer, int32 offset, int32 count) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.Common.FileSetStream.Write(System.Byte[],System.Int32,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Write (buffer As Byte(), offset As Integer, count As Integer)" />
<MemberSignature Language="F#" Value="override this.Write : byte[] * int * int -> unit" Usage="fileSetStream.Write (buffer, offset, count)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<param name="buffer">To be added.</param>
<param name="offset">To be added.</param>
<param name="count">To be added.</param>
<summary>
This operation is unsupported.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>