Data.String.Interpolate.Conversion

Documentation

type family IsCustomSink dst where ...

Does this type require special behavior when something is interpolated into it?

Equations

IsCustomSink Text = 'True

IsCustomSink Text = 'True

IsCustomSink Builder = 'True

IsCustomSink ByteString = 'True

IsCustomSink ByteString = 'True

IsCustomSink Builder = 'True

IsCustomSink _ = 'False

class IsCustomSink dst ~ flag => InterpSink (flag :: Bool) dst where

Something that can be interpolated into.

Associated Types

type Builder flag dst :: Type

Methods

ofString :: Proxy flag -> String -> B dst (Builder flag dst)

Meant to be used only for verbatim parts of the interpolation.

build :: Proxy flag -> B dst (Builder flag dst) -> B dst (Builder flag dst) -> B dst (Builder flag dst)

build should be 'in-order'; that is, the left builder comes from a string on the left, and the right builder comes from a string on the right.

finalize :: Proxy flag -> B dst (Builder flag dst) -> dst

Instances

(IsCustomSink str ~ 'False, IsString str) => InterpSink 'False str

Defined in Data.String.Interpolate.Conversion

Associated Types

type Builder 'False str

Methods

ofString :: Proxy 'False -> String -> B str (Builder 'False str)

build :: Proxy 'False -> B str (Builder 'False str) -> B str (Builder 'False str) -> B str (Builder 'False str)

finalize :: Proxy 'False -> B str (Builder 'False str) -> str

InterpSink 'True Builder

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Associated Types

type Builder 'True Builder

Methods

ofString :: Proxy 'True -> String -> B Builder (Builder0 'True Builder)

build :: Proxy 'True -> B Builder (Builder0 'True Builder) -> B Builder (Builder0 'True Builder) -> B Builder (Builder0 'True Builder)

finalize :: Proxy 'True -> B Builder (Builder0 'True Builder) -> Builder

InterpSink 'True ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Associated Types

type Builder 'True ByteString

Methods

ofString :: Proxy 'True -> String -> B ByteString (Builder 'True ByteString)

build :: Proxy 'True -> B ByteString (Builder 'True ByteString) -> B ByteString (Builder 'True ByteString) -> B ByteString (Builder 'True ByteString)

finalize :: Proxy 'True -> B ByteString (Builder 'True ByteString) -> ByteString

InterpSink 'True ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Associated Types

type Builder 'True ByteString

Methods

ofString :: Proxy 'True -> String -> B ByteString (Builder 'True ByteString)

build :: Proxy 'True -> B ByteString (Builder 'True ByteString) -> B ByteString (Builder 'True ByteString) -> B ByteString (Builder 'True ByteString)

finalize :: Proxy 'True -> B ByteString (Builder 'True ByteString) -> ByteString

InterpSink 'True Text

Defined in Data.String.Interpolate.Conversion.TextSink

Associated Types

type Builder 'True Text

Methods

ofString :: Proxy 'True -> String -> B Text (Builder 'True Text)

build :: Proxy 'True -> B Text (Builder 'True Text) -> B Text (Builder 'True Text) -> B Text (Builder 'True Text)

finalize :: Proxy 'True -> B Text (Builder 'True Text) -> Text

InterpSink 'True Builder

Defined in Data.String.Interpolate.Conversion.TextSink

Associated Types

type Builder 'True Builder

Methods

ofString :: Proxy 'True -> String -> B Builder (Builder0 'True Builder)

build :: Proxy 'True -> B Builder (Builder0 'True Builder) -> B Builder (Builder0 'True Builder) -> B Builder (Builder0 'True Builder)

finalize :: Proxy 'True -> B Builder (Builder0 'True Builder) -> Builder

InterpSink 'True Text

Defined in Data.String.Interpolate.Conversion.TextSink

Associated Types

type Builder 'True Text

Methods

ofString :: Proxy 'True -> String -> B Text (Builder 'True Text)

build :: Proxy 'True -> B Text (Builder 'True Text) -> B Text (Builder 'True Text) -> B Text (Builder 'True Text)

finalize :: Proxy 'True -> B Text (Builder 'True Text) -> Text

class InterpSink flag dst => Interpolatable (flag :: Bool) src dst where

Represents that we can interpolate objects of type src into a an interpolation string that returns type dst.

Methods

interpolate :: Proxy flag -> src -> B dst (Builder flag dst)

Instances

(IsString dst, IsCustomSink dst ~ 'False) => Interpolatable 'False Builder dst

Defined in Data.String.Interpolate.Conversion

Methods

interpolate :: Proxy 'False -> Builder -> B dst (Builder0 'False dst)

(IsString dst, IsCustomSink dst ~ 'False) => Interpolatable 'False ByteString dst

Defined in Data.String.Interpolate.Conversion

Methods

interpolate :: Proxy 'False -> ByteString -> B dst (Builder 'False dst)

(IsString dst, IsCustomSink dst ~ 'False) => Interpolatable 'False ByteString dst

Defined in Data.String.Interpolate.Conversion

Methods

interpolate :: Proxy 'False -> ByteString -> B dst (Builder 'False dst)

(IsString dst, IsCustomSink dst ~ 'False) => Interpolatable 'False Text dst

Defined in Data.String.Interpolate.Conversion

Methods

interpolate :: Proxy 'False -> Text -> B dst (Builder 'False dst)

(IsString dst, IsCustomSink dst ~ 'False) => Interpolatable 'False Builder dst

Defined in Data.String.Interpolate.Conversion

Methods

interpolate :: Proxy 'False -> Builder -> B dst (Builder0 'False dst)

(IsString dst, IsCustomSink dst ~ 'False) => Interpolatable 'False Text dst

Defined in Data.String.Interpolate.Conversion

Methods

interpolate :: Proxy 'False -> Text -> B dst (Builder 'False dst)

(IsString dst, IsCustomSink dst ~ 'False) => Interpolatable 'False String dst

Defined in Data.String.Interpolate.Conversion

Methods

interpolate :: Proxy 'False -> String -> B dst (Builder 'False dst)

(IsString dst, IsCustomSink dst ~ 'False) => Interpolatable 'False Char dst

Defined in Data.String.Interpolate.Conversion

Methods

interpolate :: Proxy 'False -> Char -> B dst (Builder 'False dst)

(Show src, IsString dst, IsCustomSink dst ~ 'False) => Interpolatable 'False src dst

Defined in Data.String.Interpolate.Conversion

Methods

interpolate :: Proxy 'False -> src -> B dst (Builder 'False dst)

Interpolatable 'True Builder Builder

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> Builder -> B Builder (Builder0 'True Builder)

Interpolatable 'True Builder ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> Builder -> B ByteString (Builder0 'True ByteString)

Interpolatable 'True Builder ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> Builder -> B ByteString (Builder0 'True ByteString)

Interpolatable 'True Builder Text

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> Builder -> B Text (Builder0 'True Text)

Interpolatable 'True Builder Builder

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> Builder0 -> B Builder (Builder1 'True Builder)

Interpolatable 'True Builder Text

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> Builder -> B Text (Builder0 'True Text)

Interpolatable 'True ByteString Builder

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> ByteString -> B Builder (Builder0 'True Builder)

Interpolatable 'True ByteString ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> ByteString -> B ByteString (Builder 'True ByteString)

Interpolatable 'True ByteString ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> ByteString -> B ByteString0 (Builder 'True ByteString0)

Interpolatable 'True ByteString Text

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> ByteString -> B Text (Builder 'True Text)

Interpolatable 'True ByteString Builder

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> ByteString -> B Builder (Builder0 'True Builder)

Interpolatable 'True ByteString Text

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> ByteString -> B Text (Builder 'True Text)

Interpolatable 'True ByteString Builder

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> ByteString -> B Builder (Builder0 'True Builder)

Interpolatable 'True ByteString ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> ByteString0 -> B ByteString (Builder 'True ByteString)

Interpolatable 'True ByteString ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> ByteString -> B ByteString (Builder 'True ByteString)

Interpolatable 'True ByteString Text

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> ByteString -> B Text (Builder 'True Text)

Interpolatable 'True ByteString Builder

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> ByteString -> B Builder (Builder0 'True Builder)

Interpolatable 'True ByteString Text

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> ByteString -> B Text (Builder 'True Text)

Interpolatable 'True Text Builder

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> Text -> B Builder (Builder0 'True Builder)

Interpolatable 'True Text ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> Text -> B ByteString (Builder 'True ByteString)

Interpolatable 'True Text ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> Text -> B ByteString (Builder 'True ByteString)

Interpolatable 'True Text Text

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> Text -> B Text (Builder 'True Text)

Interpolatable 'True Text Builder

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> Text -> B Builder (Builder0 'True Builder)

Interpolatable 'True Text Text

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> Text -> B Text0 (Builder 'True Text0)

Interpolatable 'True Builder Builder

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> Builder -> B Builder0 (Builder1 'True Builder0)

Interpolatable 'True Builder ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> Builder -> B ByteString (Builder0 'True ByteString)

Interpolatable 'True Builder ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> Builder -> B ByteString (Builder0 'True ByteString)

Interpolatable 'True Builder Text

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> Builder -> B Text (Builder0 'True Text)

Interpolatable 'True Builder Builder

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> Builder -> B Builder (Builder0 'True Builder)

Interpolatable 'True Builder Text

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> Builder -> B Text (Builder0 'True Text)

Interpolatable 'True Text Builder

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> Text -> B Builder (Builder0 'True Builder)

Interpolatable 'True Text ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> Text -> B ByteString (Builder 'True ByteString)

Interpolatable 'True Text ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> Text -> B ByteString (Builder 'True ByteString)

Interpolatable 'True Text Text

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> Text0 -> B Text (Builder 'True Text)

Interpolatable 'True Text Builder

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> Text -> B Builder (Builder0 'True Builder)

Interpolatable 'True Text Text

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> Text -> B Text (Builder 'True Text)

Interpolatable 'True String Builder

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> String -> B Builder (Builder0 'True Builder)

Interpolatable 'True String ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> String -> B ByteString (Builder 'True ByteString)

Interpolatable 'True String ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> String -> B ByteString (Builder 'True ByteString)

Interpolatable 'True String Text

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> String -> B Text (Builder 'True Text)

Interpolatable 'True String Builder

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> String -> B Builder (Builder0 'True Builder)

Interpolatable 'True String Text

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> String -> B Text (Builder 'True Text)

Interpolatable 'True Char Builder

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> Char -> B Builder (Builder0 'True Builder)

Interpolatable 'True Char ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> Char -> B ByteString (Builder 'True ByteString)

Interpolatable 'True Char ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> Char -> B ByteString (Builder 'True ByteString)

Interpolatable 'True Char Text

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> Char -> B Text (Builder 'True Text)

Interpolatable 'True Char Builder

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> Char -> B Builder (Builder0 'True Builder)

Interpolatable 'True Char Text

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> Char -> B Text (Builder 'True Text)

Show src => Interpolatable 'True src Builder

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> src -> B Builder (Builder0 'True Builder)

Show src => Interpolatable 'True src ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> src -> B ByteString (Builder 'True ByteString)

Show src => Interpolatable 'True src ByteString

Defined in Data.String.Interpolate.Conversion.ByteStringSink

Methods

interpolate :: Proxy 'True -> src -> B ByteString (Builder 'True ByteString)

Show src => Interpolatable 'True src Text

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> src -> B Text (Builder 'True Text)

Show src => Interpolatable 'True src Builder

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> src -> B Builder (Builder0 'True Builder)

Show src => Interpolatable 'True src Text

Defined in Data.String.Interpolate.Conversion.TextSink

Methods

interpolate :: Proxy 'True -> src -> B Text (Builder 'True Text)

bsToTextBuilder :: ByteString -> Builder

Convert a strict ByteString into a Text Builder, converting any invalid characters into the Unicode replacement character � (U+FFFD).

lbsToTextBuilder :: ByteString -> Builder

Convert a lazy ByteString into a Text Builder, converting any invalid characters into the Unicode replacement character � (U+FFFD).

encodeCharUTF8 :: Char -> Builder

Data.ByteString.Builder provides charUtf8 to do this, but it doesn't correctly handle invalid characters.

Orphan instances

(IsCustomSink str ~ 'False, IsString str) => InterpSink 'False str

Associated Types

type Builder 'False str

Methods

ofString :: Proxy 'False -> String -> B str (Builder 'False str)

build :: Proxy 'False -> B str (Builder 'False str) -> B str (Builder 'False str) -> B str (Builder 'False str)

finalize :: Proxy 'False -> B str (Builder 'False str) -> str

(IsString dst, IsCustomSink dst ~ 'False) => Interpolatable 'False Builder dst

Methods

interpolate :: Proxy 'False -> Builder -> B dst (Builder0 'False dst)

(IsString dst, IsCustomSink dst ~ 'False) => Interpolatable 'False ByteString dst

Methods

interpolate :: Proxy 'False -> ByteString -> B dst (Builder 'False dst)

(IsString dst, IsCustomSink dst ~ 'False) => Interpolatable 'False ByteString dst

Methods

interpolate :: Proxy 'False -> ByteString -> B dst (Builder 'False dst)

(IsString dst, IsCustomSink dst ~ 'False) => Interpolatable 'False Text dst

Methods

interpolate :: Proxy 'False -> Text -> B dst (Builder 'False dst)

(IsString dst, IsCustomSink dst ~ 'False) => Interpolatable 'False Builder dst

Methods

interpolate :: Proxy 'False -> Builder -> B dst (Builder0 'False dst)

(IsString dst, IsCustomSink dst ~ 'False) => Interpolatable 'False Text dst

Methods

interpolate :: Proxy 'False -> Text -> B dst (Builder 'False dst)

(IsString dst, IsCustomSink dst ~ 'False) => Interpolatable 'False String dst

Methods

interpolate :: Proxy 'False -> String -> B dst (Builder 'False dst)

(IsString dst, IsCustomSink dst ~ 'False) => Interpolatable 'False Char dst

Methods

interpolate :: Proxy 'False -> Char -> B dst (Builder 'False dst)

(Show src, IsString dst, IsCustomSink dst ~ 'False) => Interpolatable 'False src dst

Methods

interpolate :: Proxy 'False -> src -> B dst (Builder 'False dst)