kantan

csv

package csv

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. csv
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type CellCodec[A] = Codec[String, A, DecodeError, codecs.type]

    Aggregates a CellEncoder and a CellDecoder.

    Aggregates a CellEncoder and a CellDecoder.

    The sole purpose of this type class is to provide a convenient way to create encoders and decoders. It should not be used directly for anything but instance creation - in particular, it should never be used in a context bound or expected as an implicit parameter.

    See also

    kantan.codecs.Codec

  2. trait CellCodecInstances extends CellEncoderInstances with CellDecoderInstances

  3. type CellDecoder[A] = Decoder[String, A, DecodeError, codecs.type]

    Describes how to decode CSV cells into specific types.

    Describes how to decode CSV cells into specific types.

    All types A such that there exists an implicit instance of CellDecoder[A] in scope can be decoded from CSV cells.

    Note that instances of this type class are rarely used directly - their purpose is to be implicitly assembled into more complex instances of kantan.csv.RowDecoder.

    See the companion object for creation and summoning methods.

    See also

    kantan.codecs.Decoder

  4. trait CellDecoderInstances extends AnyRef

    All default CellDecoder instances.

  5. type CellEncoder[A] = Encoder[String, A, codecs.type]

    Describes how to encode values of a specific type to CSV cells.

    Describes how to encode values of a specific type to CSV cells.

    All types A such that there exists an implicit instance of CellEncoder[A] in scope can be encoded to CSV cells.

    Note that instances of this type class are rarely used directly - their purpose is to be implicitly assembled into more complex instances of RowEncoder.

    See the companion object for creation and summoning methods.

    See also

    kantan.codecs.Encoder

  6. trait CellEncoderInstances extends AnyRef

    All default CellEncoder instances.

  7. type CsvReader[A] = ResourceIterator[A]

  8. trait CsvSink[-S] extends Serializable

    Type class for all types that can be turned into CsvWriter instances.

  9. trait CsvSource[-S] extends Serializable

    Turns instances of S into valid sources of CSV data.

  10. trait CsvWriter[A] extends Closeable

    Type of values that know how to write CSV data.

  11. sealed abstract class DecodeError extends ReadError

    Parent type for all errors that can occur while decoding CSV data.

  12. type DecodeResult[A] = Result[DecodeError, A]

    Result of a decode operation, which can be either a success or a failure.

    Result of a decode operation, which can be either a success or a failure.

    The difference between a parse and a decode result is that the former comes from reading raw data and trying to interpret it as CSV, while the later comes from turning CSV data into useful Scala types.

    Failure cases are all encoded as DecodeError.

    See also

    kantan.codecs.Result

  13. type Failure[A] = codecs.Result.Failure[A]

  14. trait GeneratedRowCodecs extends AnyRef

  15. trait GeneratedRowDecoders extends AnyRef

  16. trait GeneratedRowEncoders extends AnyRef

  17. trait LowPriorityCsvSourceInstances extends AnyRef

  18. sealed abstract class ParseError extends ReadError

  19. type ParseResult[A] = Result[ParseError, A]

    Result of a parsing operation, which can be either a success or a failure.

    Result of a parsing operation, which can be either a success or a failure.

    The difference between a parse and a decode result is that the former comes from reading raw data and trying to interpret it as CSV, while the later comes from turning CSV data into useful Scala types.

    Failure cases are all encoded as ParseError.

    See also

    kantan.codecs.Result

  20. sealed abstract class ReadError extends Exception with Product with Serializable

    Parent type for all errors that can occur while dealing with CSV data.

  21. type ReadResult[A] = Result[ReadError, A]

    Result of a reading operation, which can be either a success or a failure.

    Result of a reading operation, which can be either a success or a failure.

    Both ParseResult and DecodeResult are valid values of type ReadResult.

    See also

    kantan.codecs.Result

  22. type RowCodec[A] = Codec[Seq[String], A, DecodeError, codecs.type]

    Aggregates a RowEncoder and a RowDecoder.

    Aggregates a RowEncoder and a RowDecoder.

    The sole purpose of this type class is to provide a convenient way to create encoders and decoders. It should not be used directly for anything but instance creation - in particular, it should never be used in a context bound or expected as an implicit parameter.

    See also

    kantan.codecs.Codec

  23. trait RowCodecInstances extends RowEncoderInstances with RowDecoderInstances

  24. type RowDecoder[A] = Decoder[Seq[String], A, DecodeError, codecs.type]

    Describes how to decode CSV rows into specific types.

    Describes how to decode CSV rows into specific types.

    All types A such that there exists an implicit instance of RowDecoder[A] in scope can be decoded from CSV rows by functions such as CsvSource.reader or CsvSource.read.

    See the companion object for creation and summoning methods.

    See also

    kantan.codecs.Decoder

  25. trait RowDecoderInstances extends AnyRef

    Provides reasonable default RowDecoder instances for various types.

  26. type RowEncoder[A] = Encoder[Seq[String], A, codecs.type]

    Describes how to encode values of a specific type to CSV rows.

    Describes how to encode values of a specific type to CSV rows.

    All types A such that there exists an implicit instance of RowEncoder[A] in scope can be encoded to CSV rows by functions such as CsvSink.writer or CsvSink.write.

    See the companion object for creation and summoning methods.

    See also

    kantan.codecs.Encoder

  27. trait RowEncoderInstances extends AnyRef

    Provides reasonable default RowEncoder instances for various types.

  28. type Success[A] = codecs.Result.Success[A]

  29. trait TupleInstances extends AnyRef

  30. type CsvInput[A] = CsvSource[A]

    Annotations
    @deprecated
    Deprecated

    (Since version 0.1.15) use CsvSource instead (see https://github.com/nrinaudo/kantan.csv/issues/49)

  31. type CsvOutput[A] = CsvSink[A]

    Annotations
    @deprecated
    Deprecated

    (Since version 0.1.15) use CsvSink instead (see https://github.com/nrinaudo/kantan.csv/issues/49)

Value Members

  1. object CellCodec

    Declares helpful methods for CellCodec creation.

  2. object CellDecoder

    Provides useful methods for summoning and creating instances of CellDecoder.

  3. object CellEncoder

    Provides useful methods for summoning and creating instances of CellEncoder.

  4. object CsvReader

    Provides instance creation and summoning methods.

  5. object CsvSink extends Serializable

    Provides default instances as well as instance summoning and creation methods.

  6. object CsvSource extends LowPriorityCsvSourceInstances with Serializable

    Defines convenience methods for creating and retrieving instances of CsvSource.

  7. object CsvWriter

    Provides useful instance creation methods.

  8. object DecodeError extends Serializable

    Declares all possible values of type DecodeError.

  9. object DecodeResult

  10. val Failure: codecs.Result.Failure.type

  11. object ParseError extends Serializable

  12. object ParseResult

  13. object RowCodec extends GeneratedRowCodecs

    Provides useful methods for RowCodec instance creation.

  14. object RowDecoder extends GeneratedRowDecoders

    Provides various instance creation and summoning methods.

  15. object RowEncoder extends GeneratedRowEncoders

    Provides various instance creation and summoning methods.

  16. val Success: codecs.Result.Success.type

  17. object codecs extends CellCodecInstances with RowCodecInstances with TupleInstances

  18. package engine

  19. package ops

Deprecated Value Members

  1. val CsvInput: CsvSource.type

    Annotations
    @deprecated
    Deprecated

    (Since version 0.1.15) use CsvSource instead (see https://github.com/nrinaudo/kantan.csv/issues/49)

  2. val CsvOutput: CsvSink.type

    Annotations
    @deprecated
    Deprecated

    (Since version 0.1.15) use CsvSink instead (see https://github.com/nrinaudo/kantan.csv/issues/49)

Inherited from AnyRef

Inherited from Any

Ungrouped