blob: b797d5f006882b0b5fc5c45b141fff60e79787b4 (
plain)
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
|
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charSet="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="apple-touch-icon" sizes="57x57" href="/CsvHelper/favicons/apple-icon-57x57.png" />
<link rel="apple-touch-icon" sizes="60x60" href="/CsvHelper/favicons/apple-icon-60x60.png" />
<link rel="apple-touch-icon" sizes="72x72" href="/CsvHelper/favicons/apple-icon-72x72.png" />
<link rel="apple-touch-icon" sizes="76x76" href="/CsvHelper/favicons/apple-icon-76x76.png" />
<link rel="apple-touch-icon" sizes="114x114" href="/CsvHelper/favicons/apple-icon-114x114.png" />
<link rel="apple-touch-icon" sizes="120x120" href="/CsvHelper/favicons/apple-icon-120x120.png" />
<link rel="apple-touch-icon" sizes="144x144" href="/CsvHelper/favicons/apple-icon-144x144.png" />
<link rel="apple-touch-icon" sizes="152x152" href="/CsvHelper/favicons/apple-icon-152x152.png" />
<link rel="apple-touch-icon" sizes="180x180" href="/CsvHelper/favicons/apple-icon-180x180.png" />
<link rel="icon" type="image/png" sizes="192x192" href="/CsvHelper/favicons/android-icon-192x192.png" />
<link rel="icon" type="image/png" sizes="32x32" href="/CsvHelper/favicons/favicon-32x32.png" />
<link rel="icon" type="image/png" sizes="96x96" href="/CsvHelper/favicons/favicon-96x96.png" />
<link rel="icon" type="image/png" sizes="16x16" href="/CsvHelper/favicons/favicon-16x16.png" />
<link rel="manifest" href="/CsvHelper/manifest.json" />
<meta name="msapplication-TileColor" content="#ffffff" />
<meta name="msapplication-TileImage" content="/ms-icon-144x144.png" />
<meta name="theme-color" content="#ffffff" />
<title>V20 | CsvHelper</title>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/bulma/0.9.1/css/bulma.min.css" />
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/default.min.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/vs.min.css" />
<link rel="stylesheet" href="/CsvHelper/styles/index.css" />
<script defer src="https://use.fontawesome.com/releases/v5.14.0/js/all.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
</head>
<body>
<header id="header" class="header">
<nav class="navbar is-light">
<div class="navbar-brand">
<a class="navbar-item" href="/CsvHelper">
<img src="/CsvHelper/images/logo.svg" width="66" height="28" />
</a>
<div id="navbar-burger" class="navbar-burger">
<span></span>
<span></span>
<span></span>
</div>
</div>
<div id="navbar-menu" class="navbar-menu">
<div class="navbar-start">
<a class="navbar-item" href="/CsvHelper/getting-started">Getting Started</a>
<a class="navbar-item" href="/CsvHelper/examples">Examples</a>
<a class="navbar-item" href="/CsvHelper/migration">Migration</a>
<a class="navbar-item" href="/CsvHelper/change-log">Change Log</a>
</div>
<div class="navbar-end">
<a class="navbar-item" href="https://twitter.com/JoshClose">
<span class="icon">
<i class="fab fa-twitter"></i>
</span>
</a>
<a class="navbar-item" href="https://github.com/JoshClose/CsvHelper">
<span class="icon">
<i class="fab fa-github"></i>
</span>
</a>
</div>
</div>
</nav>
</header>
<main id="main" class="container is-fluid">
<div class="columns is-variable is-1">
<div class="column">
<div class="content">
<h1 id="migrating-from-version-19-to-20">Migrating from version 19 to 20</h1>
<h2 id="convertusing">ConvertUsing</h2>
<p><code>ConvertUsing</code> was renamed to <code>Convert</code>.</p>
<pre><code class="language-cs">// v19
Map(m => m.Property).ConvertUsing(row => row.GetField<int>(0) + row.GetField<int>(1));
// v20
Map(m => m.Property).Convert(row => row.GetField<int>(0) + row.GetField<int>(1));
</code></pre>
<h2 id="csvconfiguration">CsvConfiguration</h2>
<p>All properties changed from <code>get; set;</code> to <code>get; init;</code>.</p>
<pre><code class="language-cs">// v19
var config = new CsvConfiguration(CultureInfo.InvariantCulture);
config.Delimiter = ";";
// v20
var config = new CsvConfiguration(CultureInfo.InvariantCulture)
{
Delimiter = ";",
}
</code></pre>
<p><code>CsvConfiguration</code> changed from a <code>class</code> to a <code>record</code>.</p>
<pre><code class="language-cs">// v19
class MyConfig : CsvConfiguration {}
// v20
record MyConfig : CsvConfiguration {}
</code></pre>
<h3 id="shouldquote">ShouldQuote</h3>
<p><code>ShouldQuote</code> now takes in <code>IWriterRow</code> instead of <code>CsvContext</code>.</p>
<pre><code class="language-cs">// v19
var config = new CsvConfiguration(CultureInfo.InvariantCulture)
{
ShouldQuote = (field, row) => true,
};
// v20
var config = new CsvConfiguration(CultureInfo.InvariantCulture)
{
ShouldQuote = (field, context) => true,
};
</code></pre>
<h3 id="newline">NewLine</h3>
<p>Changed from <code>enum NewLines</code> to <code>char?</code>.</p>
<pre><code class="language-cs">// v19
var config = new CsvConfiguration(CultureInfo.InvariantCulture)
{
NewLine = NewLines.LF,
};
// v20
var config = new CsvConfiguration(CultureInfo.InvariantCulture)
{
NewLine = '\n',
};
</code></pre>
<h3 id="newlinestring">NewLineString</h3>
<p>This was removed. Any code referencing this should be deleted.</p>
<h3 id="registerclassmap">RegisterClassMap</h3>
<p>This moved to <code>CsvContext</code>.</p>
<pre><code class="language-cs">// v19
csv.Configuration.RegisterClassMap<MyMap>();
// v20
csv.Context.RegisterClassMap<MyMap>();
</code></pre>
<h3 id="unregisterclassmap">UnregisterClassMap</h3>
<p>This moved to <code>CsvContext</code>.</p>
<pre><code class="language-cs">// v19
csv.Configuration.UnregisterClassMap<MyMap>();
// v20
csv.Context.UnregisterClassMap<MyMap>();
</code></pre>
<h3 id="automap">AutoMap</h3>
<p>This moved to <code>CsvContext</code>.</p>
<pre><code class="language-cs">// v19
csv.Configuration.AutoMap<MyType>();
// v20
csv.Context.AutoMap<MyType>();
</code></pre>
<h2 id="iparserconfiguration">IParserConfiguration</h2>
<p>All setters removed.</p>
<pre><code class="language-cs">// v19
var config = new CsvConfiguration(CultureInfo.InvariantCulture);
config.Delimiter = ";";
// v20
var config = new CsvConfiguration(CultureInfo.InvariantCulture)
{
Delimiter = ";",
};
</code></pre>
<ul>
<li>Added <code>bool CacheFields</code>.</li>
<li>Added <code>bool LeaveOpen</code>.</li>
<li>Added <code>char? NewLine</code>.</li>
<li>Added <code>ParserMode Mode</code>.</li>
<li>Added <code>char[] WhiteSpaceChars</code>.</li>
<li>Removed <code>bool IgnoreQuotes</code>.</li>
</ul>
<p>Any classes that implement <code>IParserConfiguration</code> will need these changes.</p>
<h2 id="ireaderconfiguration">IReaderConfiguration</h2>
<p>All setters removed.</p>
<pre><code class="language-cs">// v19
var config = new CsvConfiguration(CultureInfo.InvariantCulture);
config.Delimiter = ";";
// v20
var config = new CsvConfiguration(CultureInfo.InvariantCulture)
{
Delimiter = ";",
};
</code></pre>
<ul>
<li>Removed <code>TypeConverterOptionsCache</code>.</li>
<li>Removed <code>TypeConverterCache</code>.</li>
<li>Removed <code>Maps</code>.</li>
<li>Removed <code>RegisterClassMap</code>.</li>
<li>Removed <code>UnregisterClassMap</code>.</li>
<li>Removed <code>AutoMap</code>.</li>
</ul>
<p>Any classes that implement <code>IReaderConfiguration</code> will need these changes.</p>
<h2 id="iserializerconfiguration">ISerializerConfiguration</h2>
<p>This interface was removed and it's properties were added to <code>IWriteConfiguration</code>.</p>
<pre><code class="language-cs">// v19
class MyConfig : ISerializerConfiguration {}
// v20
class MyConfig : IWriterConfiguration {}
</code></pre>
<h2 id="iwriterconfiguration">IWriterConfiguration</h2>
<p>All setters removed.</p>
<pre><code class="language-cs">// v19
var config = new CsvConfiguration(CultureInfo.InvariantCulture);
config.Delimiter = ";";
// v20
var config = new CsvConfiguration(CultureInfo.InvariantCulture)
{
Delimiter = ";",
};
</code></pre>
<ul>
<li>Removed <code>QuoteString</code>.</li>
<li>Removed <code>TypeConverterCache</code>.</li>
<li>Removed <code>MemberTypes</code>.</li>
<li>Removed <code>Maps</code>.</li>
<li>Removed <code>RegisterClassMap</code>.</li>
<li>Removed <code>UnregisterClassMap</code>.</li>
<li>Removed <code>AutoMap</code>.</li>
</ul>
<p>Any classes that implement <code>IWriterConfiguration</code> will need these changes.</p>
<h2 id="membermap">MemberMap</h2>
<p><code>ConvertUsing</code> renamed to <code>Convert</code>.</p>
<pre><code class="language-cs">// v19
Map(m => m.Property).ConvertUsing(row => row.Get(0));
Map(m => m.Property).ConvertUsing(value => value?.ToString() ?? string.Empty);
// v20
Map(m => m.Property).Convert(row => row.Get(0));
Map(m => m.Property).Convert(value => value?.ToString() ?? string.Empty);
</code></pre>
<h2 id="csvparser">CsvParser</h2>
<p><code>string[] Read()</code> changed to <code>bool Read()</code>.</p>
<pre><code class="language-cs">// v19
string[] record;
while ((record = parser.Read()) != null)
{
}
// v20
while (parser.Read())
{
// Only get fields you need.
var field1 = parser[0];
var field2 = parser[1];
// Get all fields.
var record = parser.Record;
}
</code></pre>
<p>Constructor paramter <code>IFieldReader fieldReader</code> removed from all constructors.</p>
<pre><code class="language-cs">// v19
var parser = new CsvParser(fieldReader);
// v20
var parser = new CsvParser();
</code></pre>
<h2 id="csvserializer">CsvSerializer</h2>
<p>Removed. Functionality moved into <code>CsvWriter</code>.</p>
<h2 id="ifieldreader">IFieldReader</h2>
<p>Removed. Functionality moved into <code>CsvParser</code>.</p>
<h2 id="iparser">IParser</h2>
<ul>
<li>Added <code>long ByteCount</code>.</li>
<li>Added <code>long CharCount</code>.</li>
<li>Added <code>int Count</code>.</li>
<li>Added <code>string this[int index]</code>.</li>
<li>Added <code>string[] Record</code>.</li>
<li>Added <code>string RawRecord</code>.</li>
<li>Added <code>int Row</code>.</li>
<li>Added <code>int RawRow</code>.</li>
<li>Changed <code>string[] Read</code> to <code>bool Read</code>.</li>
<li>Changed <code>Task<string[]> ReadAsync</code> to <code>Task<bool> ReadAsync</code>.</li>
</ul>
<p>Any classes that implement <code>IParser</code> will need these changes.</p>
<h2 id="ireader">IReader</h2>
<ul>
<li>Removed <code>ICsvParser Parser</code>.</li>
</ul>
<p>Any classes that implement <code>IReader</code> will need these changes.</p>
<h2 id="ireaderrow">IReaderRow</h2>
<ul>
<li>Added <code>int ColumnCount</code>.</li>
<li>Added <code>int CurrentIndex</code>.</li>
<li>Added <code>string[] HeaderRecord</code>.</li>
<li>Added <code>IParser Parser</code>.</li>
</ul>
<p>Any classes that implement <code>IReaderRow</code> will need these changes.</p>
<h2 id="iserializer">ISerializer</h2>
<p>Removed. Functionality moved into <code>IWriter</code>.</p>
<h2 id="iwriterrow">IWriterRow</h2>
<ul>
<li>Added <code>string[] HeaderRecord</code>.</li>
<li>Added <code>int Row</code>.</li>
<li>Added <code>int Index</code>.</li>
</ul>
<h2 id="recordbuilder">RecordBuilder</h2>
<p>Removed. Functionality moved into <code>CsvWriter</code>.</p>
<h2 id="caches">Caches</h2>
<p><code>enum Caches</code> was removed. Modifying internal caches is not supported anymore.
Any code referencing this should be removed.</p>
<h2 id="readingcontextwritingcontext">ReadingContext/WritingContext</h2>
<p><code>ReadingContext</code> and <code>WritingContext</code> was merged into a single <code>CsvContext</code>.
Anywhere either of these was used should change to <code>CsvContext</code>.</p>
<h2 id="funcaction">Func/Action</h2>
<p>Any place a <code>Func</code> or <code>Action</code> was used now has a dedicated <code>delegate</code>.
This should only affect classes that are inheriting <code>ClassMap</code>
or <code>CsvConfiguration</code>.</p>
<h2 id="csvfieldreader">CsvFieldReader</h2>
<p>Class removed. Code was wrapped into <code>CsvParser</code>.</p>
</div>
</div>
</div>
</main>
<br /><br />
<footer id="footer" class="footer">
<div class="has-text-centered">© 2009-2022 Josh Close</div>
</footer>
<script>
hljs.configure({
tabReplace: " "
});
hljs.initHighlightingOnLoad();
</script>
<script src="/CsvHelper/scripts/header.js"></script>
<script src="/CsvHelper/scripts/sidebar.js"></script>
</body>
</html>
|
