Delimited 0.1.0
dotnet add package Delimited --version 0.1.0
NuGet\Install-Package Delimited -Version 0.1.0
<PackageReference Include="Delimited" Version="0.1.0" />
<PackageVersion Include="Delimited" Version="0.1.0" />
<PackageReference Include="Delimited" />
paket add Delimited --version 0.1.0
#r "nuget: Delimited, 0.1.0"
#:package Delimited@0.1.0
#addin nuget:?package=Delimited&version=0.1.0
#tool nuget:?package=Delimited&version=0.1.0
Delimited
F# helper to read/write delimited text streams, mostly CSV files. Utilizes Sylvan.Data.Csv to quickly parse CSV data into strings, but uses codecs to encode and decode similar to Thoth.Json.
Targets netstandard2.1 and net6.0 (dateOnly/timeOnly need net6.0).
Reading
open Delimited
open FSharp.Control
type Reading = { Name: string; Temp: float; Date: System.DateOnly }
let reading =
decoder {
let! name = Decode.field "name" Decode.string
and! temp = Decode.field "temp" Decode.float
and! date = Decode.field "date" (Decode.dateOnly "yyyy-MM-dd")
return { Name = name; Temp = temp; Date = date }
}
// TaskSeq<Result<Reading, DecodeError list>>, which is an IAsyncEnumerable.
// `and!` reports every bad field in a row, not just the first.
let rows = Table.readAsync reading (Source.File "readings.csv")
// Or throw a DecodeException on the first bad row:
let! all = Table.readOrFailAsync reading (Source.Stream stream) |> TaskSeq.toListAsync
// Or eagerly read and split on successfully parsed rows and failures
let! (successes, failures) = Table.readAllAsync reading (Source.File "readings.csv")
Sources: Source.File, Source.Stream, Source.Reader, Source.Text. A stream or reader you pass in is left open.
Table.read is the synchronous version, and Table.decodeRows decodes an in-memory string seq seq.
Date and time decoders take an exact format. For ISO 8601 (2026-03-14T10:00:00Z), use dateTimeIso, dateTimeOffsetIso, dateOnlyIso or timeOnlyIso, which also exist in Encode and Codec. When decoding, these accept basic (20260314T1000) or extended format, a space instead of the T, minutes and seconds optional, and a fraction after . or ,. They don't accept week or ordinal dates, fractional hours or minutes, or 24:00, because .NET's exact-format parsing can't express them. dateTimeIso converts any offset to UTC, and dateTimeOffsetIso requires an offset or Z.
When the format isn't known in advance, use Decode.dateTimeAuto, dateTimeOffsetAuto, dateOnlyAuto or timeOnlyAuto. These accept anything the invariant culture recognizes, so an ambiguous date like 03/04/2026 is read month first.
Writing
let encoder : RowEncoder<Reading> =
Encode.columns
[ Encode.field "name" Encode.string _.Name
Encode.field "temp" Encode.float _.Temp
Encode.field "date" (Encode.dateOnly "yyyy-MM-dd") _.Date ]
// Each write returns the number of rows written.
let count = Table.write encoder (Sink.File "out.csv") readings // seq
let! count = Table.writeAsync encoder (Sink.Stream s) asyncReadings ct // TaskSeq / IAsyncEnumerable
let! count = Table.writeAsyncWithOptions (TableOptions.withDelimiter '\t' TableOptions.defaults) encoder (Sink.Stream s) (readings |> TaskSeq.ofSeq) ct
let text = Table.writeStringWithOptions (TableOptions.withDelimiter '|' TableOptions.defaults) encoder readings
Table.encodeRows encodes to an in-memory string seq seq, with the header row first when the options have headers.
Custom fields
A FieldDecoder<'a> is just string -> Result<'a, string> and a FieldEncoder<'a> is 'a -> string, so you can define your own decoders and encoders to be able to work with any custom field:
let yesNo : FieldDecoder<bool> = function "Y" -> Ok true | "N" -> Ok false | s -> Error $"bad flag %s{s}"
let positive = Decode.int |> Decode.Field.andThen (fun i -> if i > 0 then Ok i else Error "must be positive")
let celsius = Encode.float |> Encode.Field.contramap (fun (Celsius c) -> c)
option reads a blank field as None and writes None as an empty field. When a file marks missing values some other way, use optionWith, which treats only that text (ignoring surrounding whitespace) as missing; voptionWith and optionalFieldWith work the same way in Decode, Encode and Codec:
let temp = Decode.field "temp" (Decode.optionWith "NA" Decode.float) // "NA" -> None
let name = Codec.optionWith "NULL" Codec.string // "" -> Some ""
Combinators that exist for both fields and rows live in Decode.Field/Decode.Row and Encode.Field/Encode.Row.
Decode.Field.either and Decode.Row.either try one decoder and fall back to a second. To try more than two, reduce a list with them:
let when' =
[ "yyyy-MM-dd"; "MM/dd/yyyy"; "dd.MM.yyyy" ]
|> List.map Decode.dateTime
|> List.reduce Decode.Field.either
|> Decode.field "when"
FieldCodec<'a> pairs a decoder with an encoder when you need both; pass codec.Decode to Decode.field and codec.Encode to Encode.field:
let celsius = Codec.float |> Codec.Field.map Celsius (fun (Celsius c) -> c)
let yesNoCodec = Codec.Field.create yesNo (fun b -> if b then "Y" else "N")
Codec.result and Codec.choiceOf2 round-trip only when no text is accepted by both codecs. With Codec.choiceOf2 Codec.float Codec.int, Choice2Of2 3 is written as 3 and read back as Choice1Of2 3.0.
Reading and writing the same file
The codec builder declares each column once and gives you both a decoder and an encoder:
let reading : RowCodec<Reading> =
codec {
let! name = Codec.field "name" Codec.string _.Name
and! temp = Codec.field "temp" Codec.float _.Temp
and! date = Codec.field "date" (Codec.dateOnly "yyyy-MM-dd") _.Date
return { Name = name; Temp = temp; Date = date }
}
let rows = Table.readAsync reading.Decode (Source.File "readings.csv")
Table.write reading.Encode (Sink.File "out.csv") readings |> ignore
Codec.Row.map converts a finished codec in both directions, like Codec.Field.map.
codec { } supports and! but not dependent let!. When later columns depend on earlier values, write a separate decoder { } and RowEncoder.
Dynamic data
Dynamic shapes are ordinary decoders and encoders, so they work with every source and sink:
Decode.fieldsgivesstring[];Decode.dictionary Decode.stringgivesDictionary<string, string>of every columnDecode.dictionaryOf headers Decode.stringgives only the listed columns, each of which must existEncode.fields headerswritesstring[];Encode.dictionary headers Encode.stringwritesIDictionary<string, string>Codec.dictionary headers Codec.float _.Readingscombines the two insidecodec { }; useCodec.optionwhen cells can be blankDecode.multiDictionary,multiDictionaryOf,Encode.multiDictionaryandCodec.multiDictionarydo the same withDictionary<string, 'a list>, for headers that repeatTable.withReaderAsync source (fun csvDataReader -> task { ... })gives you Sylvan's rawCsvDataReaderTable.writeDataReader sink dbDataReader(andwriteDataReaderAsync) writes anyDbDataReader, such as query results, without an encoder
Repeated headers
A header that names more than one column is an AmbiguousHeader error for field, optionalField, dictionary and dictionaryOf. Decode.fieldOccurrence "x" 1 Decode.int (or Codec.fieldOccurrence) reads the second x column, and the multiDictionary functions above read all of them.
A row that fails only because of the headers (a column that's missing, repeated, or unnamed) is the last one read, since every later row would fail the same way. A row that also has a bad value doesn't end the read.
Options
Every Table function uses TableOptions.defaults: comma-delimited, with headers and " quotes. For other options, call the WithOptions version, such as Table.readAsyncWithOptions options reading source. Build those options from the defaults with withDelimiter, withAutoDetectDelimiter (detects the delimiter when reading, writes commas), withoutHeaders and withCaseInsensitiveHeaders, or with a record update such as
{ TableOptions.defaults with HasHeaders = false; Delimiter = Specific ';' }
Decoders match column names to headers exactly by default. withCaseInsensitiveHeaders lets Decode.field "name" find a Name column. For any other matching rule, set HeaderComparer to any StringComparer. The same comparer keys the dictionaries from Decode.dictionary/dictionaryOf.
You can use the ConfigureReader/ConfigureWriter fields in TableOptions to reach any other Sylvan setting.
Development
Run the tests in Release (dotnet test -c Release). In Debug builds, taskSeq code that awaits a task that really suspends (such as a file read) can silently yield nothing. This is a known compiler issue that is fixed in a newer SDK.
To test the NuGet package itself rather than the project, run ./test-package.ps1. It packs into artifacts/ and runs PackageTests against that package.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.1 is compatible. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.1
- FSharp.Control.TaskSeq (>= 1.1.1)
- FSharp.Core (>= 6.0.1)
- Sylvan.Data (>= 0.2.17)
- Sylvan.Data.Csv (>= 1.4.4)
-
net6.0
- FSharp.Control.TaskSeq (>= 1.1.1)
- FSharp.Core (>= 6.0.1)
- Sylvan.Data (>= 0.2.17)
- Sylvan.Data.Csv (>= 1.4.4)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 0.1.0 | 52 | 11/13/2026 |
| 0.1.0-alpha3 | 56 | 11/9/2026 |
| 0.1.0-alpha2 | 56 | 11/7/2026 |
| 0.1.0-alpha1 | 51 | 11/7/2026 |