fs2-docs
3.10.2
API
Generated with
fs2-docs/fs2/text

text

fs2.text
object text

Provides utilities for working with streams of text (e.g., encoding byte streams to strings).

Attributes

Source
text.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
text.type

Members list

Type members

Classlikes

class LineTooLongException(val length: Int, val max: Int) extends RuntimeException

Attributes

Source
text.scala
Supertypes
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object base64

Functions for working with base 64.

Functions for working with base 64.

Attributes

Source
text.scala
Supertypes
class Object
trait Matchable
class Any
Self type
base64.type
object bom

Byte order mark (BOM) values for different Unicode charsets.

Byte order mark (BOM) values for different Unicode charsets.

Attributes

Source
text.scala
Supertypes
class Object
trait Matchable
class Any
Self type
bom.type
object hex

Functions for working with base 64.

Functions for working with base 64.

Attributes

Source
text.scala
Supertypes
class Object
trait Matchable
class Any
Self type
hex.type
object utf8

Attributes

Source
text.scala
Supertypes
class Object
trait Matchable
class Any
Self type
utf8.type

Value members

Concrete methods

def char2string[F[_]]: (F, Char) => String

Transforms a stream of Char to a stream of String.

Transforms a stream of Char to a stream of String.

Attributes

Source
text.scala
def decodeCWithCharset[F[_] : RaiseThrowable](charset: Charset): (F, Chunk[Byte]) => String

Attributes

Source
text.scala
def decodeWithCharset[F[_] : RaiseThrowable](charset: Charset): (F, Byte) => String

Attributes

Source
text.scala
def encode[F[_]](charset: Charset): (F, String) => Byte

Encodes a stream of String in to a stream of bytes using the given charset.

Encodes a stream of String in to a stream of bytes using the given charset.

Attributes

Source
text.scala
def encodeC[F[_]](charset: Charset): (F, String) => Chunk[Byte]

Encodes a stream of String in to a stream of Chunk[Byte] using the given charset.

Encodes a stream of String in to a stream of Chunk[Byte] using the given charset.

Attributes

Source
text.scala
def lines[F[_]]: (F, String) => String

Transforms a stream of String such that each emitted String is a line from the input.

Transforms a stream of String such that each emitted String is a line from the input.

Attributes

Source
text.scala
def linesLimited[F[_] : RaiseThrowable](maxLineLength: Int): (F, String) => String

Transforms a stream of String such that each emitted String is a line from the input

Transforms a stream of String such that each emitted String is a line from the input

Value parameters

maxLineLength

maximum size to accumulate a line to; throw an error if a line is larger

Attributes

Source
text.scala
def string2char[F[_]]: (F, String) => Char

Transforms a stream of String to a stream of Char.

Transforms a stream of String to a stream of Char.

Attributes

Source
text.scala

Deprecated methods

def utf8Decode[F[_]]: (F, Byte) => String

Converts UTF-8 encoded byte stream to a stream of String.

Converts UTF-8 encoded byte stream to a stream of String.

Attributes

Deprecated
true
Source
text.scala
def utf8DecodeC[F[_]]: (F, Chunk[Byte]) => String

Converts UTF-8 encoded Chunk[Byte] inputs to String.

Converts UTF-8 encoded Chunk[Byte] inputs to String.

Attributes

Deprecated
true
Source
text.scala
def utf8Encode[F[_]]: (F, String) => Byte

Encodes a stream of String in to a stream of bytes using the UTF-8 charset.

Encodes a stream of String in to a stream of bytes using the UTF-8 charset.

Attributes

Deprecated
true
Source
text.scala
def utf8EncodeC[F[_]]: (F, String) => Chunk[Byte]

Encodes a stream of String in to a stream of Chunk[Byte] using the UTF-8 charset.

Encodes a stream of String in to a stream of Chunk[Byte] using the UTF-8 charset.

Attributes

Deprecated
true
Source
text.scala
Generated with