Moduleos-string-2.0.7Haskell2010

System.OsString.Internal.Types

8 types
5 values

Packageos-string-2.0.7
Exports17
LanguageHaskell2010
LicenceBSD-3-Clause
SourceTypes.hs

newtypenewtype WindowsString

Commonly used windows string as wide character bytes.

Constructors

WindowsString
- getWindowsString :: ShortByteString

Instances9Eq, Ord, Show, Generic, Semigroup, Monoid, …

Eq WindowsStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
Ord WindowsStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
Show WindowsStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
Decodes as UCS-2.
Generic WindowsStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
Semigroup WindowsStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
Monoid WindowsStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
NFData WindowsStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
Lift WindowsStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
type Rep WindowsString = D1 ('MetaData "WindowsString" "System.OsString.Internal.Types" "os-string-2.0.7-3011" 'True) (C1 ('MetaCons "WindowsString" 'PrefixI 'True) (S1 ('MetaSel ('Just "getWindowsString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortByteString)))Defined in os-string-2.0.7 · System.OsString.Internal.Types

patternpattern WS :: ShortByteString -> WindowsString

Just a short bidirectional synonym for WindowsString constructor.

valueunWS :: WindowsString -> ShortByteString

newtypenewtype PosixString

Commonly used Posix string as uninterpreted char[] array.

Constructors

PosixString
- getPosixString :: ShortByteString

Instances9Eq, Ord, Show, Generic, Semigroup, Monoid, …

Eq PosixStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
Ord PosixStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
Show PosixStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
Prints the raw bytes without decoding.
Generic PosixStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
Semigroup PosixStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
Monoid PosixStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
NFData PosixStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
Lift PosixStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
type Rep PosixString = D1 ('MetaData "PosixString" "System.OsString.Internal.Types" "os-string-2.0.7-3011" 'True) (C1 ('MetaCons "PosixString" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPosixString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortByteString)))Defined in os-string-2.0.7 · System.OsString.Internal.Types

valueunPS :: PosixString -> ShortByteString

patternpattern PS :: ShortByteString -> PosixString

Just a short bidirectional synonym for PosixString constructor.

typetype PlatformString = PosixString

newtypenewtype WindowsChar

Constructors

WindowsChar
- getWindowsChar :: Word16

Instances6Eq, Ord, Show, Generic, NFData, Rep

Eq WindowsCharDefined in os-string-2.0.7 · System.OsString.Internal.Types
Ord WindowsCharDefined in os-string-2.0.7 · System.OsString.Internal.Types
Show WindowsCharDefined in os-string-2.0.7 · System.OsString.Internal.Types
Generic WindowsCharDefined in os-string-2.0.7 · System.OsString.Internal.Types
NFData WindowsCharDefined in os-string-2.0.7 · System.OsString.Internal.Types
type Rep WindowsChar = D1 ('MetaData "WindowsChar" "System.OsString.Internal.Types" "os-string-2.0.7-3011" 'True) (C1 ('MetaCons "WindowsChar" 'PrefixI 'True) (S1 ('MetaSel ('Just "getWindowsChar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16)))Defined in os-string-2.0.7 · System.OsString.Internal.Types

valueunWW :: WindowsChar -> Word16

patternpattern WW :: Word16 -> WindowsChar

Just a short bidirectional synonym for WindowsChar constructor.

newtypenewtype PosixChar

Constructors

PosixChar
- getPosixChar :: Word8

Instances6Eq, Ord, Show, Generic, NFData, Rep

Eq PosixCharDefined in os-string-2.0.7 · System.OsString.Internal.Types
Ord PosixCharDefined in os-string-2.0.7 · System.OsString.Internal.Types
Show PosixCharDefined in os-string-2.0.7 · System.OsString.Internal.Types
Generic PosixCharDefined in os-string-2.0.7 · System.OsString.Internal.Types
NFData PosixCharDefined in os-string-2.0.7 · System.OsString.Internal.Types
type Rep PosixChar = D1 ('MetaData "PosixChar" "System.OsString.Internal.Types" "os-string-2.0.7-3011" 'True) (C1 ('MetaCons "PosixChar" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPosixChar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)))Defined in os-string-2.0.7 · System.OsString.Internal.Types

valueunPW :: PosixChar -> Word8

patternpattern PW :: Word8 -> PosixChar

Just a short bidirectional synonym for PosixChar constructor.

typetype PlatformChar = PosixChar

newtypenewtype OsString

Newtype representing short operating system specific strings.

Internally this is either WindowsString or PosixString, depending on the platform. Both use unpinned ShortByteString for efficiency.

The constructor is only exported via System.OsString.Internal.Types, since dealing with the internals isn't generally recommended, but supported in case you need to write platform specific code.

Constructors

OsString
- getOsString :: PlatformString

Instances9Eq, Ord, Show, Generic, Semigroup, Monoid, …

Eq OsStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
Byte equality of the internal representation.
Ord OsStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
Byte ordering of the internal representation.
Show OsStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
On windows, decodes as UCS-2. On unix prints the raw bytes without decoding.
Generic OsStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
Semigroup OsStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
Monoid OsStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
"String-Concatenation" for OsString. This is not the same as (</>).
NFData OsStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
Lift OsStringDefined in os-string-2.0.7 · System.OsString.Internal.Types
type Rep OsString = D1 ('MetaData "OsString" "System.OsString.Internal.Types" "os-string-2.0.7-3011" 'True) (C1 ('MetaCons "OsString" 'PrefixI 'True) (S1 ('MetaSel ('Just "getOsString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PlatformString)))Defined in os-string-2.0.7 · System.OsString.Internal.Types

newtypenewtype OsChar

Newtype representing a code unit.

On Windows, this is restricted to two-octet codepoints Word16, on POSIX one-octet (Word8).

Constructors

OsChar
- getOsChar :: PlatformChar

Instances6Eq, Ord, Show, Generic, NFData, Rep

Eq OsCharDefined in os-string-2.0.7 · System.OsString.Internal.Types
Byte equality of the internal representation.
Ord OsCharDefined in os-string-2.0.7 · System.OsString.Internal.Types
Byte ordering of the internal representation.
Show OsCharDefined in os-string-2.0.7 · System.OsString.Internal.Types
Generic OsCharDefined in os-string-2.0.7 · System.OsString.Internal.Types
NFData OsCharDefined in os-string-2.0.7 · System.OsString.Internal.Types
type Rep OsChar = D1 ('MetaData "OsChar" "System.OsString.Internal.Types" "os-string-2.0.7-3011" 'True) (C1 ('MetaCons "OsChar" 'PrefixI 'True) (S1 ('MetaSel ('Just "getOsChar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PlatformChar)))Defined in os-string-2.0.7 · System.OsString.Internal.Types

value

coercionToPlatformTypes :: Either (Coercion OsChar WindowsChar, Coercion OsString WindowsString) (Coercion OsChar PosixChar, Coercion OsString PosixString)

This is a type-level evidence that OsChar is a newtype wrapper over WindowsChar or PosixChar and OsString is a newtype wrapper over WindowsString or PosixString. If you pattern match on coercionToPlatformTypes, GHC will know that relevant types are coercible to each other. This helps to avoid CPP in certain scenarios.