fs2.data.csv
Type members
Classlikes
Describes how a cell can be decoded to the given type.
Describes how a cell can be decoded to the given type.
CellDecoder
provides convenient methods such as map
, emap
, or flatMap
to build new decoders out of more
basic one.
Actually, CellDecoder
has a https://typelevel.org/cats/api/cats/MonadError.htmlcats`MonadError` instance. To
get the full power of it, import cats.implicits._
.
- Companion:
- object
- Companion:
- class
Describes how a cell of a given type can be encoded.
Describes how a cell of a given type can be encoded.
- Companion:
- object
- Companion:
- class
Controls the escaping when outputting CSV.
Controls the escaping when outputting CSV.
- Companion:
- object
Raised when processing a Csv row whose width doesn't match the width of the Csv header row
Raised when processing a Csv row whose width doesn't match the width of the Csv header row
A type class describing what it means to be a parseable CSV header.
A type class describing what it means to be a parseable CSV header.
- Companion:
- object
Describes how a row can be decoded to the given type.
Describes how a row can be decoded to the given type.
RowDecoder
provides convenient methods such as map
, emap
, or flatMap
to build new decoders out of more basic one.
Actually, RowDecoder
has a cats `MonadError`
instance. To get the full power of it, import cats.implicits._
.
Describes how a row can be decoded to the given type.
Describes how a row can be decoded to the given type.
RowDecoderF
provides convenient methods such as map
, emap
, or flatMap
to build new decoders out of more basic one.
Actually, RowDecoderF
has a cats `MonadError`
instance. To get the full power of it, import cats.implicits._
.
- Companion:
- object
Describes how a row can be encoded from a value of the given type.
Describes how a row can be encoded from a value of the given type.
- Companion:
- object
A CSV row with or without headers. The presence of headers is encoded via the first type param which is a subtype of scala.Option. By preserving this information in types, it's possible to define Row and CsvRow aliases as if they were plain case classes while keeping the code DRY.
A CSV row with or without headers. The presence of headers is encoded via the first type param which is a subtype of scala.Option. By preserving this information in types, it's possible to define Row and CsvRow aliases as if they were plain case classes while keeping the code DRY.
Operations on columns can always be performed using 0-based indices and additionally using a specified header value if headers are present (and this fact statically known).
'''Note:''' the following invariant holds when using this class: values
and headers
have the same size if headers are present.
- Companion:
- object
Low level pipes for CSV handling. All pipes only perform one step in a CSV (de)serialization pipeline, so use these if you want to customise. All standard use cases should be covered by the higher level pipes directly on the csv package which are composed of the lower level ones here.
Low level pipes for CSV handling. All pipes only perform one step in a CSV (de)serialization pipeline, so use these if you want to customise. All standard use cases should be covered by the higher level pipes directly on the csv package which are composed of the lower level ones here.
Types
A CSV row with headers, that can be used to access the cell values.
A CSV row with headers, that can be used to access the cell values.
'''Note:''' the following invariant holds when using this class: values
and headers
have the same size.
Describes how a row can be decoded to the given type.
Describes how a row can be decoded to the given type.
CsvRowDecoder
provides convenient methods such as map
, emap
, or flatMap
to build new decoders out of more basic one.
Actually, CsvRowDecoder
has a cats `MonadError`
instance. To get the full power of it, import cats.implicits._
.
Describes how a row can be encoded from a value of the given type.
Describes how a row can be encoded from a value of the given type.
Higher kinded version of scala.None. Ignores the type param.
Higher kinded version of scala.None. Ignores the type param.
Describes how a row can be decoded to the given type.
Describes how a row can be decoded to the given type.
RowDecoder
provides convenient methods such as map
, emap
, or flatMap
to build new decoders out of more basic one.
Actually, RowDecoder
has a cats `MonadError`
instance. To get the full power of it, import cats.implicits._
.
Value members
Concrete methods
Decode a char-like stream (see CharLikeChunks) into a specified type, assuming the file contains no headers, but is compliant with the set of headers given.
Decode a char-like stream (see CharLikeChunks) into a specified type, assuming the file contains no headers, but is compliant with the set of headers given.
Decode a char-like stream (see CharLikeChunks) into a specified type, assuming the file contains headers, but they shall be skipped for decoding.
Decode a char-like stream (see CharLikeChunks) into a specified type, assuming the file contains headers, but they shall be skipped for decoding.
Decode a char-like stream (see CharLikeChunks) into a specified type, assuming the file contains headers and they need to be taken into account for decoding.
Decode a char-like stream (see CharLikeChunks) into a specified type, assuming the file contains headers and they need to be taken into account for decoding.
Decode a char-like stream (see CharLikeChunks) into a specified type, assuming the file neither contains headers nor are they needed for decoding.
Decode a char-like stream (see CharLikeChunks) into a specified type, assuming the file neither contains headers nor are they needed for decoding.
Encode a specified type into a CSV prepending the given headers.
Encode a specified type into a CSV prepending the given headers.
Encode a specified type into a CSV that contains the headers determined by encoding the first element. Empty if input is.
Encode a specified type into a CSV that contains the headers determined by encoding the first element. Empty if input is.