summaryrefslogtreecommitdiff
path: root/ThirdParty/CsvHelper-master/docs/index.html
blob: 8c18cf2d7a78d8f90c9a61ace738cf04ba9afdae (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
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
<!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>A .NET library for reading and writing CSV files. Extremely fast, flexible, and easy to use. | 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="home">
	<div class="columns">
		<div class="column">
			<h1 class="title is-1">CsvHelper</h1>
			<h2 class="subtitle">A .NET library for reading and writing CSV files. Extremely fast, flexible, and easy to use.</h2>

			<div class="columns is-variable is-2">
				<div class="column is-narrow">
					<a class="button is-large is-success" href="https://www.nuget.org/packages/CsvHelper/">
						<span class="icon">
							<i class="fas fa-download"></i>
						</span>
						<span>Download</span>
					</a>
				</div>
				<div class="column is-narrow">
					<a class="button is-large is-link" href="/CsvHelper/getting-started">
						<span class="icon">
							<i class="fas fa-play-circle"></i>
						</span>
						<span>Get Started</span>
					</a>
				</div>
			</div>

		</div>
		<div class="column">
			<img src="/CsvHelper/images/logo.svg" />
		</div>
	</div>

	<h3 class="title is-3">Features</h3>
	<hr />

	<div class="columns is-multiline">
		<div class="column is-4">
			<h4 class="title is-4 has-text-weight-normal">
				<span class="icon">
					<i class="fas fa-bolt"></i>
				</span>
				<span>Fast</span>
			</h4>
			<p class="subtitle is-6">Compiles classes on the fly for extremely fast performance.</p>
		</div>

		<div class="column is-4">
			<h4 class="title is-4 has-text-weight-normal">
				<span class="icon">
					<i class="fas fa-sync-alt"></i>
				</span>
				<span>Flexible</span>
			</h4>
			<p class="subtitle is-6">Conservative when writing, liberal when reading.</p>
		</div>

		<div class="column is-4">
			<h4 class="title is-4 has-text-weight-normal">
				<span class="icon">
					<i class="fas fa-thumbs-up"></i>
				</span>
				<span>Easy to Use</span>
			</h4>
			<p class="subtitle is-6">
				Reading and writing is as simple as GetRecords&lt;T&gt;() and WriteRecords(records).
				No configuration required.
			</p>
		</div>

		<div class="column is-4">
			<h4 class="title is-4 has-text-weight-normal">
				<span class="icon">
					<i class="fas fa-cogs"></i>
				</span>
				<span>Highly Configurable</span>
			</h4>
			<p class="subtitle is-6">Feature rich mapping and attribute systems to configure any type of CSV file to any type of class.</p>
		</div>

		<div class="column is-4">
			<h4 class="title is-4 has-text-weight-normal">
				<span class="icon">
					<i class="fas fa-clipboard-check"></i>
				</span>
				<span><a href="https://tools.ietf.org/html/rfc4180" target="_blank">RFC 4180</a> Compliant</span>
			</h4>
			<p class="subtitle is-6">Adheres to the RFC 4180 standard to ensure compatibility across systems.</p>
		</div>

		<div class="column is-4">
			<h4 class="title is-4 has-text-weight-normal">
				<span class="icon">
					<i class="fab fa-linux"></i>
				</span>
				<span>Linux Mode</span>
			</h4>
			<p class="subtitle is-6">
				Mode for common Linux/SerDe files where an escape character is used instead of RFC 4180's field quoting.
			</p>
		</div>

		<div class="column is-4">
			<h4 class="title is-4 has-text-weight-normal">
				<span class="icon">
					<i class="fas fa-file-excel"></i>
				</span>
				<span>Graceful Fallback</span>
			</h4>
			<p class="subtitle is-6">When non-standard files are read, fallback will match MS Excel parsing.</p>
		</div>

		<div class="column is-4">
			<h4 class="title is-4 has-text-weight-normal">
				<span class="icon">
					<i class="fas fa-memory"></i>
				</span>
				<span>Low Memory Usage</span>
			</h4>
			<p class="subtitle is-6">Reading records will yield results so only one record is in memory at a time.</p>
		</div>

		<div class="column is-4">
			<h4 class="title is-4 has-text-weight-normal">
				<span class="icon">
					<i class="fas fa-database"></i>
				</span>
				<span>Field Caching</span>
			</h4>
			<p class="subtitle is-6">
				Option to use field caching when there is repeated data in a CSV file. This will reduce memory
				and speed up parsing time.
			</p>
		</div>

		<div class="column is-4">
			<h4 class="title is-4 has-text-weight-normal">
				<span class="icon">
					<i class="fab fa-apple"></i>
				</span>
				<span>Run Anywhere</span>
			</h4>
			<p class="subtitle is-6">
				CsvHelper is built on .NET Standard 2.0 which allows it to run
				<a href="https://docs.microsoft.com/en-us/dotnet/standard/net-standard" target="_blank">almost everywhere</a>.
				Older versions of .NET are possible if needed.
			</p>
		</div>

		<div class="column is-4">
			<h4 class="title is-4 has-text-weight-normal">
				<span class="icon">
					<i class="fab fa-github"></i>
				</span>
				<span>Open Source</span>
			</h4>
			<p class="subtitle is-6">
				Many contributors have helped make CsvHelper the great library it is today.
				Completely free for commercial use. Dual licensed under
				<a href="https://opensource.org/licenses/MS-PL" target="_blank">MS-PL</a> and
				<a href="https://opensource.org/licenses/Apache-2.0" target="_blank">Apache 2</a>.
			</p>
		</div>
	</div>

	<br />

	<h3 class="title is-3">Help</h3>
	<hr />

	<div class="columns is-multiline">
		<div class="column is-4">
			<h4 class="title is-4 has-text-weight-normal">
				<span class="icon">
					<i class="fab fa-stack-overflow"></i>
				</span>
				<span>Stack Overflow</span>
			</h4>
			<p class="subtitle is-6">
				<a href="https://stackoverflow.com/questions/tagged/csvhelper">Stack Overflow</a>
				has millions of users in its community just waiting to answer your questions.
				There is only one of me and I'm pretty busy.
				<span class="icon">
					<i class="fas fa-grin-squint-tears"></i>
				</span>
			</p>
		</div>

		<div class="column is-4">
			<h4 class="title is-4 has-text-weight-normal">
				<span class="icon">
					<i class="fas fa-book"></i>
				</span>
				<span>Documentation</span>
			</h4>
			<p class="subtitle is-6">
				Learn how to use CsvHelper using the <a href="/CsvHelper/api">API reference</a>
				or check out some <a href="/CsvHelper/examples">examples</a>.
			</p>
		</div>

		<div class="column is-4">
			<h4 class="title is-4 has-text-weight-normal">
				<span class="icon">
					<i class="fas fa-bug"></i>
				</span>
				<span>Features Requests and Bugs</span>
			</h4>
			<p class="subtitle is-6">
				If you have a feature request or have found a bug, you can
				<a href="https://github.com/joshclose/csvhelper/issues" target="_blank">log an issue</a>.
				Please use
				<a href="https://stackoverflow.com/questions/tagged/csvhelper" target="_blank" rel="nofollow">Stack&nbsp;Overflow</a>
				if you have a question.
			</p>
		</div>
	</div>

	<br />

	<h3 class="title is-3">License</h3>
	<hr />

	<p>Completely free for commercial use. Dual licensed. Choose which ever license suits your needs.</p>
	<p><a href="https://opensource.org/licenses/MS-PL" target="_blank" rel="nofollow">Microsoft Public License (MS-PL)</a></p>
	<p><a href="https://opensource.org/licenses/Apache-2.0" target="_blank" rel="nofollow">Apache License, Version 2.0</a></p>

	<br /><br />

	<h3 class="title is-3">Contributions</h3>
	<hr />

	<div class="content">
		<p>Want to contribute? Great! Here are a few guidelines.</p>
		<ol>
			<li>
				If you want to do a feature, post an issue about the feature first. Some features are intentionally left out,
				some features may already be in the works, or I may have some advice on how I think it should be done. I would
				feel bad if time was spent on some code that won't be used.
			</li>
			<li>
				If you want to do a bug fix, it might not be a bad idea to post about it too. I've had the same bug fixed by
				multiple people at the same time before.
			</li>
			<li>
				All code should have a unit test. If you make a feature, there should be significant tests around the feature.
				If you do a bug fix, there should be a test specific to that bug so it doesn't happen again.
			</li>
			<li>
				Pull requests should have a single commit. If you have multiple commits, squash them into a single commit before
				requesting a pull.
			</li>
			<li>
				When in Rome: Try and follow the code styling already in place. I use default Visual Studio Text Editor settings
				but change tabs to Keep tabs.
			</li>
		</ol>
	</div>

	<br />

	<h3 class="title is-3">Contributors</h3>
	<hr />

	<a href="https://github.com/JoshClose/CsvHelper/graphs/contributors">
		<img src="https://camo.githubusercontent.com/be8184ec3d8d1a25fbf40e461eb193d178fb8e5a/68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f63737668656c7065722f636f6e7472696275746f72732e7376673f77696474683d38393026627574746f6e3d66616c7365" data-canonical-src="https://opencollective.com/csvhelper/contributors.svg?width=890&amp;button=false" style="max-width: 100%" />
	</a>

	<br /><br />

	<h3 class="title is-3">Donations</h3>
	<hr />

	<div class="columns is-multiline">
		<div class="column is-4">
			<h4 class="title is-4 has-text-weight-normal">
				<span class="icon">
					<i class="fab fa-paypal"></i>
				</span>
				<span>One Time Donation</span>
			</h4>
			<p class="subtitle is-6">
				You can do a one time donation through
				<a href="https://www.paypal.me/closejosh" target="_blank" rel="nofollow">Paypal</a>.
			</p>
		</div>

		<div class="column is-4">
			<h4 class="title is-4 has-text-weight-normal">
				<span class="icon">
					<i class="fab fa-osi"></i>
				</span>
				<span>Recurring Donations</span>
			</h4>
			<p class="subtitle is-6">
				You can do recurring donations through
				<a href="https://opencollective.com/csvhelper" target="_blank" rel="nofollow">Open Collective</a>.
			</p>
		</div>

		<div class="column is-4">
			<h4 class="title is-4 has-text-weight-normal">
				<span class="icon">
					<i class="fab fa-amazon"></i>
				</span>
				<span>Wish List</span>
			</h4>
			<p class="subtitle is-6">
				If you want to do something a little more fun, you can pick something
				from my <a href="http://a.co/7EwAZXU" target="_blank" rel="nofollow">Amazon wish list</a>. This
				obviously doesn't go directly towards building software, but does help
				keep me sane when I'm not.
			</p>
		</div>
	</div>

	<h3 class="title is-3">Backers</h3>
	<hr />

	<a href="https://opencollective.com/csvhelper#backers" target="_blank" rel="nofollow">
		<img src="https://camo.githubusercontent.com/47a6bf22fd6cbdd06e076c8710fcfe422e333e86/68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f63737668656c7065722f6261636b6572732e7376673f77696474683d383930" data-canonical-src="https://opencollective.com/csvhelper/backers.svg?width=890" style={{ maxWidth: "100%" }} />
	</a>

	<h3 class="title is-3">Sponsors</h3>
	<hr />

	<a href="https://opencollective.com/csvhelper/sponsor/0/website" target="_blank" rel="nofollow">
		<img src="https://camo.githubusercontent.com/8c4b18a584bc3d249062d169f460ee2d3b8f7373/68747470733a2f2f6f70656e636f6c6c6563746976652e636f6d2f63737668656c7065722f73706f6e736f722f302f6176617461722e737667" data-canonical-src="https://opencollective.com/csvhelper/sponsor/0/avatar.svg" style={{ maxWidth: "100%" }} />
	</a>
</div>

				</div>
		</div>
	</main>

	<br /><br />

	<footer id="footer" class="footer">
	<div class="has-text-centered">&copy; 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>