Modulefilepath-1.5.4.0Haskell2010

System.OsPath.Encoding

Contents

Types
UCS-2
UTF-16LE_b
base encoding

Synopsis

data EncodingException
value showEncodingException
value ucs2le
value mkUcs2le
value ucs2le_DF
value ucs2le_EF
value ucs2le_decode
value ucs2le_encode
value utf16le_b
value mkUTF16le_b
value utf16le_b_DF
value utf16le_b_EF
value utf16le_b_decode
value utf16le_b_encode
value encodeWithBasePosix
value decodeWithBasePosix
value encodeWithBaseWindows
value decodeWithBaseWindows

Packagefilepath-1.5.4.0
Exports18
LanguageHaskell2010
LicenceBSD-3-Clause
SourceInternal.hs

Types

datadata EncodingException

Constructors

EncodingError String (Maybe Word8)
Could not decode a byte sequence because it was invalid under the given encoding, or ran out of input in mid-decode.

Instances4Eq, Show, Exception, NFData

Eq EncodingExceptionDefined in os-string-2.0.8 · System.OsString.Encoding.Internal
Show EncodingExceptionDefined in os-string-2.0.8 · System.OsString.Encoding.Internal
Exception EncodingExceptionDefined in os-string-2.0.8 · System.OsString.Encoding.Internal
NFData EncodingExceptionDefined in os-string-2.0.8 · System.OsString.Encoding.Internal

valueshowEncodingException :: EncodingException -> String

UCS-2

valueucs2le :: TextEncoding

valuemkUcs2le :: CodingFailureMode -> TextEncoding

valueucs2le_DF :: CodingFailureMode -> IO (TextDecoder ())

valueucs2le_EF :: CodingFailureMode -> IO (TextEncoder ())

valueucs2le_decode :: DecodeBuffer

valueucs2le_encode :: EncodeBuffer

UTF-16LE_b

valueutf16le_b :: TextEncoding

Source#

Mimics the base encoding for filesystem operations. This should be total on all inputs (word16 byte arrays).

Note that this has a subtle difference to encodeWithBaseWindows/decodeWithBaseWindows: it doesn't care for the 0x0000 end marker and will as such produce different results. Use takeWhile (/= 'NUL') on the input to recover this behavior.

valuemkUTF16le_b :: CodingFailureMode -> TextEncoding

valueutf16le_b_DF :: CodingFailureMode -> IO (TextDecoder ())

valueutf16le_b_EF :: CodingFailureMode -> IO (TextEncoder ())

valueutf16le_b_decode :: DecodeBuffer

valueutf16le_b_encode :: EncodeBuffer

base encoding

valueencodeWithBasePosix :: String -> IO ShortByteString

Source#

This mimics the filepath encoder base uses on unix (using PEP-383), with the small distinction that we're not truncating at NUL bytes (because we're not at the outer FFI layer).

valuedecodeWithBasePosix :: ShortByteString -> IO String

Source#

This mimics the filepath decoder base uses on unix (using PEP-383), with the small distinction that we're not truncating at NUL bytes (because we're not at the outer FFI layer).

valueencodeWithBaseWindows :: String -> IO ShortByteString

Source#

This mimics the filepath dencoder base uses on windows, with the small distinction that we're not truncating at NUL bytes (because we're not at the outer FFI layer).

valuedecodeWithBaseWindows :: ShortByteString -> IO String

Source#

This mimics the filepath decoder base uses on windows, with the small distinction that we're not truncating at NUL bytes (because we're not at the outer FFI layer).