System.OsPath.Encoding · filepath-1.5.4.0

Types

2 declarations

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.7 · System.OsString.Encoding.Internal
Show EncodingExceptionDefined in os-string-2.0.7 · System.OsString.Encoding.Internal
Exception EncodingExceptionDefined in os-string-2.0.7 · System.OsString.Encoding.Internal
NFData EncodingExceptionDefined in os-string-2.0.7 · System.OsString.Encoding.Internal

valueshowEncodingException :: EncodingException -> String

#

UCS-2

6 declarations

valueucs2le :: TextEncoding

#

valuemkUcs2le :: CodingFailureMode -> TextEncoding

#

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

#

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

#

valueucs2le_decode :: DecodeBuffer

#

valueucs2le_encode :: EncodeBuffer

#

UTF-16LE_b

6 declarations

valueutf16le_b :: TextEncoding

#

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

4 declarations

valueencodeWithBasePosix :: String -> IO ShortByteString

#

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

#

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

#

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

#

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).