fs2.data.csv

package 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
Supertypes
class Object
trait Matchable
class Any

Attributes

Source
CellDecoder.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CellDecoder.type

Attributes

Source
CellDecoder.scala
Supertypes
class Object
trait Matchable
class Any
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
Supertypes
class Object
trait Matchable
class Any

Attributes

Source
CellEncoder.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CellEncoder.type

Attributes

Source
CellEncoder.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CellEncoder.type
class CsvException(msg: String, val line: Option[Long], inner: Throwable) extends Exception

Attributes

Source
exceptions.scala
Supertypes
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
object CsvRow

Attributes

Source
CsvRow.scala
Supertypes
class Object
trait Matchable
class Any
Self type
CsvRow.type
object CsvRowDecoder

Attributes

Source
CsvRowDecoder.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object CsvRowEncoder

Attributes

Source
CsvRowEncoder.scala
Supertypes
class Object
trait Matchable
class Any
Self type
class DecoderError(msg: String, val line: Option[Long], inner: Throwable) extends CsvException

Attributes

Source
exceptions.scala
Supertypes
class CsvException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
trait EnumDecoders

Attributes

Source
EnumDecoders.scala
Supertypes
class Object
trait Matchable
class Any
trait EnumEncoders

Attributes

Source
EnumEncoders.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CellEncoder.type
sealed trait EscapeMode

Controls the escaping when outputting CSV.

Controls the escaping when outputting CSV.

Attributes

Companion
object
Source
EscapeMode.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Always.type
object Auto.type
object Never.type
object EscapeMode

Attributes

Companion
trait
Source
EscapeMode.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
EscapeMode.type
final case class Exported[A](instance: A) extends AnyVal

Attributes

Source
Exported.scala
Supertypes
trait Serializable
trait Product
trait Equals
class AnyVal
trait Matchable
class Any
Show all

Attributes

Source
CellDecoder.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CellDecoder.type

Attributes

Source
CellEncoder.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CellEncoder.type

Attributes

Source
RowDecoderF.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object RowDecoderF.type

Attributes

Source
RowEncoderF.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object RowEncoderF.type
sealed trait HasHeaders[H <: (Option), Header] extends RowF[H, Header] => CsvRow[Header]

Witness that a RowF has headers of a certain type.

Witness that a RowF has headers of a certain type.

Attributes

Companion
object
Source
HasHeaders.scala
Supertypes
trait RowF[H, Header] => CsvRow[Header]
class Object
trait Matchable
class Any
object HasHeaders

Attributes

Companion
trait
Source
HasHeaders.scala
Supertypes
class Object
trait Matchable
class Any
Self type
HasHeaders.type
class HeaderError(msg: String, val line: Option[Long], inner: Throwable) extends CsvException

Attributes

Source
exceptions.scala
Supertypes
class CsvException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
class HeaderSizeError(msg: String, val expectedColumns: Int, val actualColumns: Int, val line: Option[Long], inner: Throwable) extends HeaderError

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
Supertypes
class HeaderError
class CsvException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all

Attributes

Source
LiteralCellDecoders.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CellDecoder.type

Attributes

Source
LiteralCellEncoders.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CellEncoder.type
trait ParseableHeader[Header]

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
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Attributes

Companion
trait
Source
ParseableHeader.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final class PartiallyAppliedDecodeGivenHeaders[T](val dummy: Boolean) extends AnyVal

Attributes

Source
package.scala
Supertypes
class AnyVal
trait Matchable
class Any
final class PartiallyAppliedDecodeSkippingHeaders[T](val dummy: Boolean) extends AnyVal

Attributes

Source
package.scala
Supertypes
class AnyVal
trait Matchable
class Any
final class PartiallyAppliedDecodeUsingHeaders[T](val dummy: Boolean) extends AnyVal

Attributes

Source
package.scala
Supertypes
class AnyVal
trait Matchable
class Any
final class PartiallyAppliedDecodeWithoutHeaders[T](val dummy: Boolean) extends AnyVal

Attributes

Source
package.scala
Supertypes
class AnyVal
trait Matchable
class Any
final class PartiallyAppliedEncodeGivenHeaders[T](val dummy: Boolean) extends AnyVal

Attributes

Source
package.scala
Supertypes
class AnyVal
trait Matchable
class Any
final class PartiallyAppliedEncodeUsingFirstHeaders[T](val dummy: Boolean) extends AnyVal

Attributes

Source
package.scala
Supertypes
class AnyVal
trait Matchable
class Any
final class PartiallyAppliedEncodeWithoutHeaders[T](val dummy: Boolean) extends AnyVal

Attributes

Source
package.scala
Supertypes
class AnyVal
trait Matchable
class Any

Attributes

Source
PlatformCellDecoders.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CellDecoder.type

Attributes

Source
PlatformCellEncoders.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CellEncoder.type
object QuoteHandling

Attributes

Companion
trait
Source
package.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait QuoteHandling

Attributes

Companion
object
Source
package.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Literal.type
object RFCCompliant.type
object Row

Attributes

Source
Row.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Row.type
object RowDecoder

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
Supertypes
class Object
trait Matchable
class Any
Self type
RowDecoder.type
trait RowDecoderF[H <: (Option), T, Header]

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
Supertypes
class Object
trait Matchable
class Any

Attributes

Companion
trait
Source
RowDecoderF.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object RowEncoder

Attributes

Source
RowEncoder.scala
Supertypes
class Object
trait Matchable
class Any
Self type
RowEncoder.type
trait RowEncoderF[H <: (Option), T, Header]

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
Supertypes
class Object
trait Matchable
class Any

Attributes

Companion
trait
Source
RowEncoderF.scala
Supertypes
class Object
trait Matchable
class Any
Self type
case class RowF[H <: (Option), Header](values: NonEmptyList[String], headers: H[NonEmptyList[Header]], line: Option[Long])

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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RowF

Attributes

Companion
class
Source
RowF.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
RowF.type
trait WriteableHeader[Header]

Attributes

Companion
object
Source
WriteableHeader.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object StringWriteableHeader.type

Attributes

Companion
trait
Source
WriteableHeader.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object lenient

Attributes

Source
package.scala
Supertypes
class Object
trait Matchable
class Any
Self type
lenient.type
object lowlevel

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
Supertypes
class Object
trait Matchable
class Any
Self type
lowlevel.type

Types

type CsvRow[Header] = RowF[Some, Header]

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
type CsvRowDecoder[T, Header] = RowDecoderF[Some, T, Header]

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
type CsvRowEncoder[T, Header] = RowEncoderF[Some, T, Header]

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

Source
package.scala
type DecoderResult[T] = Either[DecoderError, T]

Attributes

Source
package.scala
type HeaderResult[T] = Either[HeaderError, NonEmptyList[T]]

Attributes

Source
package.scala
type NoneF[+A] = None.type

Higher kinded version of scala.None. Ignores the type param.

Higher kinded version of scala.None. Ignores the type param.

Attributes

Source
package.scala
type Row = RowF[NoneF, Nothing]

A CSV row without headers.

A CSV row without headers.

Attributes

Source
package.scala
type RowDecoder[T] = RowDecoderF[NoneF, T, Nothing]

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
type RowEncoder[T] = RowEncoderF[NoneF, T, Nothing]

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

Source
package.scala

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 prepending the given headers.

Attributes

Source
package.scala

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.

Encode a specified type into a CSV that contains no headers.

Attributes

Source
package.scala