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
|
// Copyright 2009-2022 Josh Close
// This file is a part of CsvHelper and is dual licensed under MS-PL and Apache 2.0.
// See LICENSE.txt for details or visit http://www.opensource.org/licenses/ms-pl.html for MS-PL and http://opensource.org/licenses/Apache-2.0 for Apache 2.0.
// https://github.com/JoshClose/CsvHelper
using System;
using CsvHelper.Configuration;
using CsvHelper.TypeConversion;
namespace CsvHelper
{
/// <summary>
/// Defines methods used to read parsed data
/// from a CSV file row.
/// </summary>
public interface IReaderRow
{
/// <summary>
/// Gets the column count of the current row.
/// This should match <see cref="IParser.Count"/>.
/// </summary>
int ColumnCount { get; }
/// <summary>
/// Gets the field index the reader is currently on.
/// </summary>
int CurrentIndex { get; }
/// <summary>
/// Gets the header record.
/// </summary>
string[]? HeaderRecord { get; }
/// <summary>
/// Gets the parser.
/// </summary>
IParser Parser { get; }
/// <summary>
/// Gets the reading context.
/// </summary>
CsvContext Context { get; }
/// <summary>
/// Gets or sets the configuration.
/// </summary>
IReaderConfiguration Configuration { get; }
/// <summary>
/// Gets the raw field at position (column) index.
/// </summary>
/// <param name="index">The zero based index of the field.</param>
/// <returns>The raw field.</returns>
string? this[int index] { get; }
/// <summary>
/// Gets the raw field at position (column) name.
/// </summary>
/// <param name="name">The named index of the field.</param>
/// <returns>The raw field.</returns>
string? this[string name] { get; }
/// <summary>
/// Gets the raw field at position (column) name.
/// </summary>
/// <param name="name">The named index of the field.</param>
/// <param name="index">The zero based index of the field.</param>
/// <returns>The raw field.</returns>
string? this[string name, int index] { get; }
/// <summary>
/// Gets the raw field at position (column) index.
/// </summary>
/// <param name="index">The zero based index of the field.</param>
/// <returns>The raw field.</returns>
string? GetField(int index);
/// <summary>
/// Gets the raw field at position (column) name.
/// </summary>
/// <param name="name">The named index of the field.</param>
/// <returns>The raw field.</returns>
string? GetField(string name);
/// <summary>
/// Gets the raw field at position (column) name and the index
/// instance of that field. The index is used when there are
/// multiple columns with the same header name.
/// </summary>
/// <param name="name">The named index of the field.</param>
/// <param name="index">The zero based index of the instance of the field.</param>
/// <returns>The raw field.</returns>
string? GetField(string name, int index);
/// <summary>
/// Gets the field converted to <see cref="Object"/> using
/// the specified <see cref="ITypeConverter"/>.
/// </summary>
/// <param name="type">The type of the field.</param>
/// <param name="index">The index of the field.</param>
/// <returns>The field converted to <see cref="Object"/>.</returns>
object? GetField(Type type, int index);
/// <summary>
/// Gets the field converted to <see cref="Object"/> using
/// the specified <see cref="ITypeConverter"/>.
/// </summary>
/// <param name="type">The type of the field.</param>
/// <param name="name">The named index of the field.</param>
/// <returns>The field converted to <see cref="Object"/>.</returns>
object? GetField(Type type, string name);
/// <summary>
/// Gets the field converted to <see cref="Object"/> using
/// the specified <see cref="ITypeConverter"/>.
/// </summary>
/// <param name="type">The type of the field.</param>
/// <param name="name">The named index of the field.</param>
/// <param name="index">The zero based index of the instance of the field.</param>
/// <returns>The field converted to <see cref="Object"/>.</returns>
object? GetField(Type type, string name, int index);
/// <summary>
/// Gets the field converted to <see cref="Object"/> using
/// the specified <see cref="ITypeConverter"/>.
/// </summary>
/// <param name="type">The type of the field.</param>
/// <param name="index">The index of the field.</param>
/// <param name="converter">The <see cref="ITypeConverter"/> used to convert the field to <see cref="Object"/>.</param>
/// <returns>The field converted to <see cref="Object"/>.</returns>
object? GetField(Type type, int index, ITypeConverter converter);
/// <summary>
/// Gets the field converted to <see cref="Object"/> using
/// the specified <see cref="ITypeConverter"/>.
/// </summary>
/// <param name="type">The type of the field.</param>
/// <param name="name">The named index of the field.</param>
/// <param name="converter">The <see cref="ITypeConverter"/> used to convert the field to <see cref="Object"/>.</param>
/// <returns>The field converted to <see cref="Object"/>.</returns>
object? GetField(Type type, string name, ITypeConverter converter);
/// <summary>
/// Gets the field converted to <see cref="Object"/> using
/// the specified <see cref="ITypeConverter"/>.
/// </summary>
/// <param name="type">The type of the field.</param>
/// <param name="name">The named index of the field.</param>
/// <param name="index">The zero based index of the instance of the field.</param>
/// <param name="converter">The <see cref="ITypeConverter"/> used to convert the field to <see cref="Object"/>.</param>
/// <returns>The field converted to <see cref="Object"/>.</returns>
object? GetField(Type type, string name, int index, ITypeConverter converter);
/// <summary>
/// Gets the field converted to <see cref="Type"/> T at position (column) index.
/// </summary>
/// <typeparam name="T">The <see cref="Type"/> of the field.</typeparam>
/// <param name="index">The zero based index of the field.</param>
/// <returns>The field converted to <see cref="Type"/> T.</returns>
T? GetField<T>(int index);
/// <summary>
/// Gets the field converted to <see cref="Type"/> T at position (column) name.
/// </summary>
/// <typeparam name="T">The <see cref="Type"/> of the field.</typeparam>
/// <param name="name">The named index of the field.</param>
/// <returns>The field converted to <see cref="Type"/> T.</returns>
T? GetField<T>(string name);
/// <summary>
/// Gets the field converted to <see cref="Type"/> T at position
/// (column) name and the index instance of that field. The index
/// is used when there are multiple columns with the same header name.
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="name">The named index of the field.</param>
/// <param name="index">The zero based index of the instance of the field.</param>
/// <returns></returns>
T? GetField<T>(string name, int index);
/// <summary>
/// Gets the field converted to <see cref="Type"/> T at position (column) index using
/// the given <see cref="ITypeConverter" />.
/// </summary>
/// <typeparam name="T">The <see cref="Type"/> of the field.</typeparam>
/// <param name="index">The zero based index of the field.</param>
/// <param name="converter">The <see cref="ITypeConverter"/> used to convert the field to <see cref="Type"/> T.</param>
/// <returns>The field converted to <see cref="Type"/> T.</returns>
T? GetField<T>(int index, ITypeConverter converter);
/// <summary>
/// Gets the field converted to <see cref="Type"/> T at position (column) name using
/// the given <see cref="ITypeConverter" />.
/// </summary>
/// <typeparam name="T">The <see cref="Type"/> of the field.</typeparam>
/// <param name="name">The named index of the field.</param>
/// <param name="converter">The <see cref="ITypeConverter"/> used to convert the field to <see cref="Type"/> T.</param>
/// <returns>The field converted to <see cref="Type"/> T.</returns>
T? GetField<T>(string name, ITypeConverter converter);
/// <summary>
/// Gets the field converted to <see cref="Type"/> T at position
/// (column) name and the index instance of that field. The index
/// is used when there are multiple columns with the same header name.
/// </summary>
/// <typeparam name="T">The <see cref="Type"/> of the field.</typeparam>
/// <param name="name">The named index of the field.</param>
/// <param name="index">The zero based index of the instance of the field.</param>
/// <param name="converter">The <see cref="ITypeConverter"/> used to convert the field to <see cref="Type"/> T.</param>
/// <returns>The field converted to <see cref="Type"/> T.</returns>
T? GetField<T>(string name, int index, ITypeConverter converter);
/// <summary>
/// Gets the field converted to <see cref="Type"/> T at position (column) index using
/// the given <see cref="ITypeConverter" />.
/// </summary>
/// <typeparam name="T">The <see cref="Type"/> of the field.</typeparam>
/// <typeparam name="TConverter">The <see cref="ITypeConverter"/> used to convert the field to <see cref="Type"/> T.</typeparam>
/// <param name="index">The zero based index of the field.</param>
/// <returns>The field converted to <see cref="Type"/> T.</returns>
T? GetField<T, TConverter>(int index) where TConverter : ITypeConverter;
/// <summary>
/// Gets the field converted to <see cref="Type"/> T at position (column) name using
/// the given <see cref="ITypeConverter" />.
/// </summary>
/// <typeparam name="T">The <see cref="Type"/> of the field.</typeparam>
/// <typeparam name="TConverter">The <see cref="ITypeConverter"/> used to convert the field to <see cref="Type"/> T.</typeparam>
/// <param name="name">The named index of the field.</param>
/// <returns>The field converted to <see cref="Type"/> T.</returns>
T? GetField<T, TConverter>(string name) where TConverter : ITypeConverter;
/// <summary>
/// Gets the field converted to <see cref="Type"/> T at position
/// (column) name and the index instance of that field. The index
/// is used when there are multiple columns with the same header name.
/// </summary>
/// <typeparam name="T">The <see cref="Type"/> of the field.</typeparam>
/// <typeparam name="TConverter">The <see cref="ITypeConverter"/> used to convert the field to <see cref="Type"/> T.</typeparam>
/// <param name="name">The named index of the field.</param>
/// <param name="index">The zero based index of the instance of the field.</param>
/// <returns>The field converted to <see cref="Type"/> T.</returns>
T? GetField<T, TConverter>(string name, int index) where TConverter : ITypeConverter;
/// <summary>
/// Gets the field converted to <see cref="System.Type"/> T at position (column) index.
/// </summary>
/// <param name="type">The <see cref="System.Type"/> of the field.</param>
/// <param name="index">The zero based index of the field.</param>
/// <param name="field">The field converted to type T.</param>
/// <returns>A value indicating if the get was successful.</returns>
bool TryGetField(Type type, int index, out object? field);
/// <summary>
/// Gets the field converted to <see cref="System.Type"/> T at position (column) name.
/// </summary>
/// <param name="type">The <see cref="System.Type"/> of the field.</param>
/// <param name="name">The named index of the field.</param>
/// <param name="field">The field converted to <see cref="System.Type"/> T.</param>
/// <returns>A value indicating if the get was successful.</returns>
bool TryGetField(Type type, string name, out object? field);
/// <summary>
/// Gets the field converted to <see cref="System.Type"/> T at position
/// (column) name and the index instance of that field. The index
/// is used when there are multiple columns with the same header name.
/// </summary>
/// <param name="type">The <see cref="System.Type"/> of the field.</param>
/// <param name="name">The named index of the field.</param>
/// <param name="index">The zero based index of the instance of the field.</param>
/// <param name="field">The field converted to <see cref="System.Type"/> T.</param>
/// <returns>A value indicating if the get was successful.</returns>
bool TryGetField(Type type, string name, int index, out object? field);
/// <summary>
/// Gets the field converted to <see cref="System.Type"/> T at position (column) index
/// using the specified <see cref="ITypeConverter" />.
/// </summary>
/// <param name="type">The <see cref="System.Type"/> of the field.</param>
/// <param name="index">The zero based index of the field.</param>
/// <param name="converter">The <see cref="ITypeConverter"/> used to convert the field to <see cref="System.Type"/> T.</param>
/// <param name="field">The field converted to <see cref="System.Type"/> T.</param>
/// <returns>A value indicating if the get was successful.</returns>
bool TryGetField(Type type, int index, ITypeConverter converter, out object? field);
/// <summary>
/// Gets the field converted to <see cref="System.Type"/> T at position (column) name
/// using the specified <see cref="ITypeConverter"/>.
/// </summary>
/// <param name="type">The <see cref="System.Type"/> of the field.</param>
/// <param name="name">The named index of the field.</param>
/// <param name="converter">The <see cref="ITypeConverter"/> used to convert the field to <see cref="System.Type"/> T.</param>
/// <param name="field">The field converted to <see cref="System.Type"/> T.</param>
/// <returns>A value indicating if the get was successful.</returns>
bool TryGetField(Type type, string name, ITypeConverter converter, out object? field);
/// <summary>
/// Gets the field converted to <see cref="System.Type"/> T at position (column) name
/// using the specified <see cref="ITypeConverter"/>.
/// </summary>
/// <param name="type">The <see cref="System.Type"/> of the field.</param>
/// <param name="name">The named index of the field.</param>
/// <param name="index">The zero based index of the instance of the field.</param>
/// <param name="converter">The <see cref="ITypeConverter"/> used to convert the field to <see cref="System.Type"/> T.</param>
/// <param name="field">The field converted to <see cref="System.Type"/> T.</param>
/// <returns>A value indicating if the get was successful.</returns>
bool TryGetField(Type type, string name, int index, ITypeConverter converter, out object? field);
/// <summary>
/// Gets the field converted to <see cref="Type"/> T at position (column) index.
/// </summary>
/// <typeparam name="T">The <see cref="Type"/> of the field.</typeparam>
/// <param name="index">The zero based index of the field.</param>
/// <param name="field">The field converted to type T.</param>
/// <returns>A value indicating if the get was successful.</returns>
bool TryGetField<T>(int index, out T? field);
/// <summary>
/// Gets the field converted to <see cref="Type"/> T at position (column) name.
/// </summary>
/// <typeparam name="T">The <see cref="Type"/> of the field.</typeparam>
/// <param name="name">The named index of the field.</param>
/// <param name="field">The field converted to <see cref="Type"/> T.</param>
/// <returns>A value indicating if the get was successful.</returns>
bool TryGetField<T>(string name, out T? field);
/// <summary>
/// Gets the field converted to <see cref="Type"/> T at position
/// (column) name and the index instance of that field. The index
/// is used when there are multiple columns with the same header name.
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="name">The named index of the field.</param>
/// <param name="index">The zero based index of the instance of the field.</param>
/// <param name="field">The field converted to <see cref="Type"/> T.</param>
/// <returns>A value indicating if the get was successful.</returns>
bool TryGetField<T>(string name, int index, out T? field);
/// <summary>
/// Gets the field converted to <see cref="Type"/> T at position (column) index
/// using the specified <see cref="ITypeConverter" />.
/// </summary>
/// <typeparam name="T">The <see cref="Type"/> of the field.</typeparam>
/// <param name="index">The zero based index of the field.</param>
/// <param name="converter">The <see cref="ITypeConverter"/> used to convert the field to <see cref="Type"/> T.</param>
/// <param name="field">The field converted to <see cref="Type"/> T.</param>
/// <returns>A value indicating if the get was successful.</returns>
bool TryGetField<T>(int index, ITypeConverter converter, out T? field);
/// <summary>
/// Gets the field converted to <see cref="Type"/> T at position (column) name
/// using the specified <see cref="ITypeConverter"/>.
/// </summary>
/// <typeparam name="T">The <see cref="Type"/> of the field.</typeparam>
/// <param name="name">The named index of the field.</param>
/// <param name="converter">The <see cref="ITypeConverter"/> used to convert the field to <see cref="Type"/> T.</param>
/// <param name="field">The field converted to <see cref="Type"/> T.</param>
/// <returns>A value indicating if the get was successful.</returns>
bool TryGetField<T>(string name, ITypeConverter converter, out T? field);
/// <summary>
/// Gets the field converted to <see cref="Type"/> T at position (column) name
/// using the specified <see cref="ITypeConverter"/>.
/// </summary>
/// <typeparam name="T">The <see cref="Type"/> of the field.</typeparam>
/// <param name="name">The named index of the field.</param>
/// <param name="index">The zero based index of the instance of the field.</param>
/// <param name="converter">The <see cref="ITypeConverter"/> used to convert the field to <see cref="Type"/> T.</param>
/// <param name="field">The field converted to <see cref="Type"/> T.</param>
/// <returns>A value indicating if the get was successful.</returns>
bool TryGetField<T>(string name, int index, ITypeConverter converter, out T? field);
/// <summary>
/// Gets the field converted to <see cref="Type"/> T at position (column) index
/// using the specified <see cref="ITypeConverter" />.
/// </summary>
/// <typeparam name="T">The <see cref="Type"/> of the field.</typeparam>
/// <typeparam name="TConverter">The <see cref="ITypeConverter"/> used to convert the field to <see cref="Type"/> T.</typeparam>
/// <param name="index">The zero based index of the field.</param>
/// <param name="field">The field converted to <see cref="Type"/> T.</param>
/// <returns>A value indicating if the get was successful.</returns>
bool TryGetField<T, TConverter>(int index, out T? field) where TConverter : ITypeConverter;
/// <summary>
/// Gets the field converted to <see cref="Type"/> T at position (column) name
/// using the specified <see cref="ITypeConverter"/>.
/// </summary>
/// <typeparam name="T">The <see cref="Type"/> of the field.</typeparam>
/// <typeparam name="TConverter">The <see cref="ITypeConverter"/> used to convert the field to <see cref="Type"/> T.</typeparam>
/// <param name="name">The named index of the field.</param>
/// <param name="field">The field converted to <see cref="Type"/> T.</param>
/// <returns>A value indicating if the get was successful.</returns>
bool TryGetField<T, TConverter>(string name, out T? field) where TConverter : ITypeConverter;
/// <summary>
/// Gets the field converted to <see cref="Type"/> T at position (column) name
/// using the specified <see cref="ITypeConverter"/>.
/// </summary>
/// <typeparam name="T">The <see cref="Type"/> of the field.</typeparam>
/// <typeparam name="TConverter">The <see cref="ITypeConverter"/> used to convert the field to <see cref="Type"/> T.</typeparam>
/// <param name="name">The named index of the field.</param>
/// <param name="index">The zero based index of the instance of the field.</param>
/// <param name="field">The field converted to <see cref="Type"/> T.</param>
/// <returns>A value indicating if the get was successful.</returns>
bool TryGetField<T, TConverter>(string name, int index, out T? field) where TConverter : ITypeConverter;
/// <summary>
/// Gets the record converted into <see cref="Type"/> T.
/// </summary>
/// <typeparam name="T">The <see cref="Type"/> of the record.</typeparam>
/// <returns>The record converted to <see cref="Type"/> T.</returns>
T? GetRecord<T>();
/// <summary>
/// Get the record converted into <see cref="System.Type"/> T.
/// </summary>
/// <typeparam name="T">The <see cref="System.Type"/> of the record.</typeparam>
/// <param name="anonymousTypeDefinition">The anonymous type definition to use for the record.</param>
/// <returns>The record converted to <see cref="System.Type"/> T.</returns>
T? GetRecord<T>(T anonymousTypeDefinition);
/// <summary>
/// Gets the record.
/// </summary>
/// <param name="type">The <see cref="Type"/> of the record.</param>
/// <returns>The record.</returns>
object? GetRecord(Type type);
}
}
|
