o

fs2.data.csv

lowlevel

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.

Source
package.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. lowlevel
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def attemptDecode[F[_], R](implicit R: RowDecoder[R]): Pipe[F, Row, DecoderResult[R]]

    Decodes simple rows (without headers) into a specified type using a suitable RowDecoder, but signal errors as values.

  6. def attemptDecodeRow[F[_], Header, R](implicit R: CsvRowDecoder[R, Header]): Pipe[F, CsvRow[Header], DecoderResult[R]]

    Decodes CsvRows (with headers) into a specified type using a suitable CsvRowDecoder, but signal errors as values.

  7. def attemptFlatMapDecodeRow[F[_], Header, R](implicit R: CsvRowDecoder[R, Header]): (Stream[F, Either[CsvException, CsvRow[Header]]]) => Stream[F, Either[CsvException, R]]

    Decodes CsvRows (with headers) into a specified type using a suitable CsvRowDecoder, but signal errors as values from both header as well as rows.

  8. def attemptWithHeaders[F[_], Header](headers: NonEmptyList[Header]): Pipe[F, Row, Either[CsvException, CsvRow[Header]]]

    Transforms a stream of raw CSV rows into parsed CSV rows with given headers.

  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def decode[F[_], R](implicit F: RaiseThrowable[F], R: RowDecoder[R]): Pipe[F, Row, R]

    Decodes simple rows (without headers) into a specified type using a suitable RowDecoder.

  11. def decodeRow[F[_], Header, R](implicit F: RaiseThrowable[F], R: CsvRowDecoder[R, Header]): Pipe[F, CsvRow[Header], R]

    Decodes CsvRows (with headers) into a specified type using a suitable CsvRowDecoder.

  12. def encode[F[_], R](implicit R: RowEncoder[R]): Pipe[F, R, Row]

    Encode a given type into simple CSV rows without headers.

  13. def encodeRow[F[_], Header, R](implicit R: CsvRowEncoder[R, Header]): Pipe[F, R, CsvRow[Header]]

    Encode a given type into CSV rows with headers.

  14. def encodeRowWithFirstHeaders[F[_], Header](implicit H: WriteableHeader[Header]): Pipe[F, CsvRow[Header], NonEmptyList[String]]

    Encode a given type into CSV row with headers taken from the first element.

    Encode a given type into CSV row with headers taken from the first element. If the input stream is empty, the output is as well.

  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def headers[F[_], Header](implicit F: RaiseThrowable[F], Header: ParseableHeader[Header]): Pipe[F, Row, CsvRow[Header]]

    Transforms a stream of raw CSV rows into parsed CSV rows with headers.

  21. def headersAttempt[F[_], Header](implicit Header: ParseableHeader[Header]): Pipe[F, Row, Either[CsvException, CsvRow[Header]]]

    Transforms a stream of raw CSV rows into parsed CSV rows with headers, with failures at the element level instead of failing the stream

  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def noHeaders[F[_]]: Pipe[F, Row, Row]

    Transforms a stream of raw CSV rows into rows.

  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. def rows[F[_], T](separator: Char = ',', quoteHandling: QuoteHandling = QuoteHandling.RFCCompliant)(implicit F: RaiseThrowable[F], T: CharLikeChunks[F, T]): Pipe[F, T, Row]

    Transforms a stream of characters into a stream of CSV rows.

    Transforms a stream of characters into a stream of CSV rows.

    separator

    character to use to separate fields in the CSV

    quoteHandling

    use QuoteHandling.RFCCompliant for RFC-4180 handling of quotation marks (optionally quoted if the value begins with a quotation mark; the default) or QuoteHandling.Literal if quotation marks should be treated literally

  28. def skipHeaders[F[_]]: Pipe[F, Row, Row]

    Transforms a stream of raw CSV rows into rows, skipping the first row to ignore the headers.

  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. def toRowStrings[F[_]](separator: Char = ',', newline: String = "\n", escape: EscapeMode = EscapeMode.Auto): Pipe[F, NonEmptyList[String], String]

    Serialize a CSV row to Strings.

    Serialize a CSV row to Strings. Guaranteed to emit one String per CSV row (= one line if no quoted newlines are contained in the value).

  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def toStrings[F[_]](separator: Char = ',', newline: String = "\n", escape: EscapeMode = EscapeMode.Auto): Pipe[F, NonEmptyList[String], String]

    Serialize a CSV row to Strings.

    Serialize a CSV row to Strings. No guarantees are given on how the resulting Strings are cut.

  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  36. def withHeaders[F[_], Header](headers: NonEmptyList[Header])(implicit F: RaiseThrowable[F]): Pipe[F, Row, CsvRow[Header]]

    Transforms a stream of raw CSV rows into parsed CSV rows with given headers.

  37. def writeWithHeaders[F[_], Header](headers: NonEmptyList[Header])(implicit H: WriteableHeader[Header]): Pipe[F, Row, NonEmptyList[String]]

    Encode a given type into CSV rows using a set of explicitly given headers.

  38. def writeWithoutHeaders[F[_]]: Pipe[F, Row, NonEmptyList[String]]

    Encode a given type into CSV rows without headers.

Inherited from AnyRef

Inherited from Any

Ungrouped