fs2.data.csv
Members list
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.syntax.all._
.
Attributes
- Companion:
- object
- Source:
- CellDecoder.scala
- Graph
- Supertypes
Attributes
- Companion:
- trait
- Source:
- CellDecoder.scala
- Graph
- Supertypes
- trait PlatformCellDecoderstrait ExportedCellDecoderstrait LiteralCellDecoderstrait CellDecoderInstances2trait CellDecoderInstances1class Objecttrait Matchableclass Any
- Self type
- CellDecoder.type
Attributes
- Source:
- CellDecoder.scala
- Graph
- Supertypes
- Known subtypes
- object CellDecoder.type
Attributes
- Source:
- CellDecoder.scala
- Graph
- Supertypes
- Known subtypes
- object CellDecoder.type
Describes how a cell of a given type can be encoded.
Describes how a cell of a given type can be encoded.
Attributes
- Companion:
- object
- Source:
- CellEncoder.scala
- Graph
- Supertypes
Attributes
- Companion:
- trait
- Source:
- CellEncoder.scala
- Graph
- Supertypes
- trait PlatformCellEncoderstrait ExportedCellEncoderstrait EnumEncoderstrait LiteralCellEncoderstrait CellEncoderInstances2trait CellEncoderInstances1class Objecttrait Matchableclass Any
- Self type
- CellEncoder.type
Attributes
- Source:
- CellEncoder.scala
- Graph
- Supertypes
- Known subtypes
- object CellEncoder.type
Attributes
- Source:
- CellEncoder.scala
- Graph
- Supertypes
- Known subtypes
- object CellEncoder.type
Attributes
- Source:
- exceptions.scala
- Graph
- Supertypes
- Known subtypes
Attributes
- Source:
- CsvRow.scala
- Graph
- Supertypes
- Self type
- CsvRow.type
Attributes
- Source:
- CsvRowDecoder.scala
- Graph
- Supertypes
- Self type
- CsvRowDecoder.type
Attributes
- Source:
- CsvRowEncoder.scala
- Graph
- Supertypes
- Self type
- CsvRowEncoder.type
Attributes
- Source:
- exceptions.scala
- Graph
- Supertypes
- class CsvExceptionclass Exceptionclass Throwabletrait Serializableclass Objecttrait Matchableclass Any
Attributes
- Source:
- EnumDecoders.scala
- Graph
- Supertypes
Attributes
- Source:
- EnumEncoders.scala
- Graph
- Supertypes
- Known subtypes
- object CellEncoder.type
Attributes
- Companion:
- trait
- Source:
- EscapeMode.scala
- Graph
- Supertypes
- Self type
- EscapeMode.type
Attributes
- Source:
- Exported.scala
- Graph
- Supertypes
Attributes
- Source:
- CellDecoder.scala
- Graph
- Supertypes
- Known subtypes
- object CellDecoder.type
Attributes
- Source:
- CellEncoder.scala
- Graph
- Supertypes
- Known subtypes
- object CellEncoder.type
Attributes
- Source:
- RowDecoderF.scala
- Graph
- Supertypes
- Known subtypes
- object RowDecoderF.type
Attributes
- Source:
- RowEncoderF.scala
- Graph
- Supertypes
- Known subtypes
- object RowEncoderF.type
Attributes
- Companion:
- trait
- Source:
- HasHeaders.scala
- Graph
- Supertypes
- Self type
- HasHeaders.type
Attributes
- Source:
- exceptions.scala
- Graph
- Supertypes
- class CsvExceptionclass Exceptionclass Throwabletrait Serializableclass Objecttrait Matchableclass Any
- Known subtypes
- class HeaderSizeError
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
Attributes
- Source:
- exceptions.scala
- Graph
- Supertypes
- class HeaderErrorclass CsvExceptionclass Exceptionclass Throwabletrait Serializableclass Objecttrait Matchableclass Any
Attributes
- Source:
- LiteralCellDecoders.scala
- Graph
- Supertypes
- Known subtypes
- object CellDecoder.type
Attributes
- Source:
- LiteralCellEncoders.scala
- Graph
- Supertypes
- Known subtypes
- object CellEncoder.type
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.
Attributes
- Companion:
- object
- Source:
- ParseableHeader.scala
- Graph
- Supertypes
- Known subtypes
- object NonEmptyStringParseableHeader.typeobject NothingParseableHeader.typeobject StringParseableHeader.type
Attributes
- Companion:
- trait
- Source:
- ParseableHeader.scala
- Graph
- Supertypes
- Self type
- ParseableHeader.type
Attributes
- Source:
- package.scala
- Graph
- Supertypes
- class AnyValtrait Matchableclass Any
Attributes
- Source:
- package.scala
- Graph
- Supertypes
- class AnyValtrait Matchableclass Any
Attributes
- Source:
- package.scala
- Graph
- Supertypes
- class AnyValtrait Matchableclass Any
Attributes
- Source:
- package.scala
- Graph
- Supertypes
- class AnyValtrait Matchableclass Any
Attributes
- Source:
- package.scala
- Graph
- Supertypes
- class AnyValtrait Matchableclass Any
Attributes
- Source:
- package.scala
- Graph
- Supertypes
- class AnyValtrait Matchableclass Any
Attributes
- Source:
- package.scala
- Graph
- Supertypes
- class AnyValtrait Matchableclass Any
Attributes
- Source:
- PlatformCellDecoders.scala
- Graph
- Supertypes
- Known subtypes
- object CellDecoder.type
Attributes
- Source:
- PlatformCellEncoders.scala
- Graph
- Supertypes
- Known subtypes
- object CellEncoder.type
Attributes
- Companion:
- trait
- Source:
- package.scala
- Graph
- Supertypes
- Self type
- QuoteHandling.type
Attributes
- Companion:
- object
- Source:
- package.scala
- Graph
- Supertypes
- Known subtypes
- object Literal.typeobject RFCCompliant.type
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.syntax.all._
.
Attributes
- Source:
- RowDecoder.scala
- Graph
- Supertypes
- Self type
- RowDecoder.type
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.syntax.all._
.
Attributes
- Companion:
- object
- Source:
- RowDecoderF.scala
- Graph
- Supertypes
Attributes
- Companion:
- trait
- Source:
- RowDecoderF.scala
- Graph
- Supertypes
- Self type
- RowDecoderF.type
Attributes
- Source:
- RowEncoder.scala
- Graph
- Supertypes
- Self type
- RowEncoder.type
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.
Attributes
- Companion:
- object
- Source:
- RowEncoderF.scala
- Graph
- Supertypes
Attributes
- Companion:
- trait
- Source:
- RowEncoderF.scala
- Graph
- Supertypes
- Self type
- RowEncoderF.type
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.
Attributes
- Companion:
- object
- Source:
- RowF.scala
- Graph
- Supertypes
Attributes
- Companion:
- class
- Source:
- RowF.scala
- Graph
- Supertypes
- Self type
- RowF.type
Attributes
- Companion:
- object
- Source:
- WriteableHeader.scala
- Graph
- Supertypes
- Known subtypes
- object StringWriteableHeader.type
Attributes
- Companion:
- trait
- Source:
- WriteableHeader.scala
- Graph
- Supertypes
- Self type
- WriteableHeader.type
Attributes
- Source:
- package.scala
- Graph
- Supertypes
- Self type
- lenient.type
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.
Attributes
- Source:
- package.scala
- Graph
- Supertypes
- Self type
- lowlevel.type
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.
Attributes
- Source:
- package.scala
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.syntax.all._
.
Attributes
- Source:
- package.scala
Describes how a row can be encoded from a value of the given type.
Attributes
- Source:
- package.scala
Attributes
- Source:
- package.scala
Higher kinded version of scala.None. Ignores the type param.
A CSV row without headers.
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.syntax.all._
.
Attributes
- Source:
- package.scala
Describes how a row can be encoded from a value of the given type.
Value members
Concrete methods
Decode a char-like stream (see fs2.data.text.CharLikeChunks) into a specified type.
Decode a char-like stream (see fs2.data.text.CharLikeChunks) into a specified type.
Scenarios:
- If skipHeaders is false, then the file contains no headers.
- If skipHeaders is true, then the headers in the file will be skipped.
For both scenarios the file is assumed to be compliant with the set of headers given.
Attributes
- Source:
- package.scala
Decode a char-like stream (see fs2.data.text.CharLikeChunks) into a specified type, assuming the file contains headers, but they shall be skipped for decoding.
Decode a char-like stream (see fs2.data.text.CharLikeChunks) into a specified type, assuming the file contains headers, but they shall be skipped for decoding.
Attributes
- Source:
- package.scala
Decode a char-like stream (see fs2.data.text.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 fs2.data.text.CharLikeChunks) into a specified type, assuming the file contains headers and they need to be taken into account for decoding.
Attributes
- Source:
- package.scala
Decode a char-like stream (see fs2.data.text.CharLikeChunks) into a specified type, assuming the file neither contains headers nor are they needed for decoding.
Decode a char-like stream (see fs2.data.text.CharLikeChunks) into a specified type, assuming the file neither contains headers nor are they needed for decoding.
Attributes
- Source:
- package.scala
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.
Attributes
- Source:
- package.scala
Encode a specified type into a CSV that contains no headers.