Safe Haskell	None
Language	Haskell2010

System.OsString.Posix

Contents

Types
String construction
String deconstruction
Word construction
Word deconstruction

Synopsis

data PosixString
data PosixChar
toPlatformString :: String -> PosixString
toPlatformStringIO :: String -> IO PosixString
bsToPlatformString :: MonadThrow m => ByteString -> m PosixString
pstr :: QuasiQuoter
packPlatformString :: [PosixChar] -> PosixString
fromPlatformString :: MonadThrow m => PosixString -> m String
fromPlatformStringEnc :: PosixString -> TextEncoding -> Either UnicodeException String
fromPlatformStringIO :: PosixString -> IO String
unpackPlatformString :: PosixString -> [PosixChar]
unsafeFromChar :: Char -> PosixChar
toChar :: PosixChar -> Char

Types

data PosixString Source #

Commonly used Posix string as uninterpreted char[] array.

Instances

Instances details

Eq PosixString Source #
Instance details Defined in System.OsString.Internal.Types Methods (==) :: PosixString -> PosixString -> Bool # (/=) :: PosixString -> PosixString -> Bool #
Ord PosixString Source #
Instance details Defined in System.OsString.Internal.Types Methods compare :: PosixString -> PosixString -> Ordering # (<) :: PosixString -> PosixString -> Bool # (<=) :: PosixString -> PosixString -> Bool # (>) :: PosixString -> PosixString -> Bool # (>=) :: PosixString -> PosixString -> Bool # max :: PosixString -> PosixString -> PosixString # min :: PosixString -> PosixString -> PosixString #
Read PosixString Source #	Encodes as UTF-8.
Instance details Defined in System.OsString.Internal.Types Methods readsPrec :: Int -> ReadS PosixString # readList :: ReadS [PosixString] # readPrec :: ReadPrec PosixString # readListPrec :: ReadPrec [PosixString] #
Show PosixString Source #	Decodes as UTF-8 and replaces invalid chars with unicode replacement char U+FFFD.
Instance details Defined in System.OsString.Internal.Types Methods showsPrec :: Int -> PosixString -> ShowS # show :: PosixString -> String # showList :: [PosixString] -> ShowS #
IsString PosixString Source #
Instance details Defined in System.OsString.Internal.Types Methods fromString :: String -> PosixString #
Generic PosixString Source #
Instance details Defined in System.OsString.Internal.Types Associated Types type Rep PosixString :: Type -> Type # Methods from :: PosixString -> Rep PosixString x # to :: Rep PosixString x -> PosixString #
Semigroup PosixString Source #
Instance details Defined in System.OsString.Internal.Types Methods (<>) :: PosixString -> PosixString -> PosixString # sconcat :: NonEmpty PosixString -> PosixString # stimes :: Integral b => b -> PosixString -> PosixString #
Monoid PosixString Source #
Instance details Defined in System.OsString.Internal.Types Methods mempty :: PosixString # mappend :: PosixString -> PosixString -> PosixString # mconcat :: [PosixString] -> PosixString #
NFData PosixString Source #
Instance details Defined in System.OsString.Internal.Types Methods rnf :: PosixString -> () #
Lift PosixString Source #
Instance details Defined in System.OsString.Internal.Types Methods lift :: PosixString -> Q Exp # liftTyped :: PosixString -> Q (TExp PosixString) #
type Rep PosixString Source #
Instance details Defined in System.OsString.Internal.Types type Rep PosixString = D1 ('MetaData "PosixString" "System.OsString.Internal.Types" "filepath-2.0.0.0-inplace" 'True) (C1 ('MetaCons "PS" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPFP") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortByteString)))

data PosixChar Source #

Instances

Instances details

Eq PosixChar Source #
Instance details Defined in System.OsString.Internal.Types Methods (==) :: PosixChar -> PosixChar -> Bool # (/=) :: PosixChar -> PosixChar -> Bool #
Ord PosixChar Source #
Instance details Defined in System.OsString.Internal.Types Methods compare :: PosixChar -> PosixChar -> Ordering # (<) :: PosixChar -> PosixChar -> Bool # (<=) :: PosixChar -> PosixChar -> Bool # (>) :: PosixChar -> PosixChar -> Bool # (>=) :: PosixChar -> PosixChar -> Bool # max :: PosixChar -> PosixChar -> PosixChar # min :: PosixChar -> PosixChar -> PosixChar #
Show PosixChar Source #
Instance details Defined in System.OsString.Internal.Types Methods showsPrec :: Int -> PosixChar -> ShowS # show :: PosixChar -> String # showList :: [PosixChar] -> ShowS #
Generic PosixChar Source #
Instance details Defined in System.OsString.Internal.Types Associated Types type Rep PosixChar :: Type -> Type # Methods from :: PosixChar -> Rep PosixChar x # to :: Rep PosixChar x -> PosixChar #
NFData PosixChar Source #
Instance details Defined in System.OsString.Internal.Types Methods rnf :: PosixChar -> () #
type Rep PosixChar Source #
Instance details Defined in System.OsString.Internal.Types type Rep PosixChar = D1 ('MetaData "PosixChar" "System.OsString.Internal.Types" "filepath-2.0.0.0-inplace" 'True) (C1 ('MetaCons "PW" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPW") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)))

String construction

toPlatformString :: String -> PosixString Source #

Total Unicode-friendly encoding.

On windows this encodes as UTF16, which is expected. On unix this encodes as UTF8, which is a good guess.

toPlatformStringIO :: String -> IO PosixString Source #

Like toPlatformString, except on unix this uses the current locale for encoding instead of always UTF8.

Looking up the locale requires IO. If you're not worried about calls to setFileSystemEncoding, then unsafePerformIO may be feasible.

bsToPlatformString :: MonadThrow m => ByteString -> m PosixString Source #

Constructs an platform string from a ByteString.

On windows, this ensures valid UTF16, on unix it is passed unchanged/unchecked.

Throws UnicodeException on invalid UTF16 on windows.

pstr :: QuasiQuoter Source #

QuasiQuote a PosixString. This accepts Unicode characters and encodes as UTF-8 on unix.

packPlatformString :: [PosixChar] -> PosixString Source #

String deconstruction

fromPlatformString :: MonadThrow m => PosixString -> m String Source #

Partial unicode friendly decoding.

On windows this decodes as UTF16 (which is the expected filename encoding). On unix this decodes as UTF8 (which is a good guess). Note that filenames on unix are encoding agnostic char arrays.

Throws a UnicodeException if decoding fails.

fromPlatformStringEnc :: PosixString -> TextEncoding -> Either UnicodeException String Source #

Like fromPlatformString, except on unix this uses the provided TextEncoding for decoding.

fromPlatformStringIO :: PosixString -> IO String Source #

Like fromPlatformString, except on unix this uses the current locale for decoding instead of always UTF8.

Looking up the locale requires IO. If you're not worried about calls to setFileSystemEncoding, then unsafePerformIO may be feasible.

Throws UnicodeException if decoding fails.

unpackPlatformString :: PosixString -> [PosixChar] Source #

Word construction

unsafeFromChar :: Char -> PosixChar Source #

Truncates to 1 octet.

Word deconstruction

toChar :: PosixChar -> Char Source #

Converts back to a unicode codepoint (total).