W3cubDocs

/Haskell 9

System.OsString.Internal.Types

Safe Haskell None
Language Haskell2010

newtype WindowsString Source

Commonly used windows string as wide character bytes.

Constructors

WindowsString

Fields

Instances
Instances details
NFData WindowsString Source
Instance details

Defined in System.OsString.Internal.Types

Methods

rnf :: WindowsString -> () Source

Monoid WindowsString Source
Instance details

Defined in System.OsString.Internal.Types

Methods

mempty :: WindowsString

mappend :: WindowsString -> WindowsString -> WindowsString

mconcat :: [WindowsString] -> WindowsString

Semigroup WindowsString Source
Instance details

Defined in System.OsString.Internal.Types

Methods

(<>) :: WindowsString -> WindowsString -> WindowsString

sconcat :: NonEmpty WindowsString -> WindowsString

stimes :: Integral b => b -> WindowsString -> WindowsString

Generic WindowsString Source
Instance details

Defined in System.OsString.Internal.Types

Associated Types

type Rep WindowsString
Instance details

Defined in System.OsString.Internal.Types

type Rep WindowsString = D1 ('MetaData "WindowsString" "System.OsString.Internal.Types" "os-string-2.0.7-3f43" 'True) (C1 ('MetaCons "WindowsString" 'PrefixI 'True) (S1 ('MetaSel ('Just "getWindowsString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortByteString)))

Methods

from :: WindowsString -> Rep WindowsString x

to :: Rep WindowsString x -> WindowsString

Show WindowsString Source

Decodes as UCS-2.
Instance details

Defined in System.OsString.Internal.Types

Methods

showsPrec :: Int -> WindowsString -> ShowS

show :: WindowsString -> String

showList :: [WindowsString] -> ShowS

Eq WindowsString Source
Instance details

Defined in System.OsString.Internal.Types

Methods

(==) :: WindowsString -> WindowsString -> Bool

(/=) :: WindowsString -> WindowsString -> Bool

Ord WindowsString Source
Instance details

Defined in System.OsString.Internal.Types

Methods

compare :: WindowsString -> WindowsString -> Ordering

(<) :: WindowsString -> WindowsString -> Bool

(<=) :: WindowsString -> WindowsString -> Bool

(>) :: WindowsString -> WindowsString -> Bool

(>=) :: WindowsString -> WindowsString -> Bool

max :: WindowsString -> WindowsString -> WindowsString

min :: WindowsString -> WindowsString -> WindowsString

Lift WindowsString Source
Instance details

Defined in System.OsString.Internal.Types

Methods

lift :: Quote m => WindowsString -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => WindowsString -> Code m WindowsString

type Rep WindowsString Source
Instance details

Defined in System.OsString.Internal.Types

type Rep WindowsString = D1 ('MetaData "WindowsString" "System.OsString.Internal.Types" "os-string-2.0.7-3f43" 'True) (C1 ('MetaCons "WindowsString" 'PrefixI 'True) (S1 ('MetaSel ('Just "getWindowsString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortByteString)))

pattern WS :: ShortByteString -> WindowsString Source

Just a short bidirectional synonym for WindowsString constructor.

unWS :: WindowsString -> ShortByteString Source

newtype PosixString Source

Commonly used Posix string as uninterpreted char[] array.

Constructors

PosixString

Fields

Instances
Instances details
NFData PosixString Source
Instance details

Defined in System.OsString.Internal.Types

Methods

rnf :: PosixString -> () Source

Monoid PosixString Source
Instance details

Defined in System.OsString.Internal.Types

Methods

mempty :: PosixString

mappend :: PosixString -> PosixString -> PosixString

mconcat :: [PosixString] -> 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

Generic PosixString Source
Instance details

Defined in System.OsString.Internal.Types

Associated Types

type Rep PosixString
Instance details

Defined in System.OsString.Internal.Types

type Rep PosixString = D1 ('MetaData "PosixString" "System.OsString.Internal.Types" "os-string-2.0.7-3f43" 'True) (C1 ('MetaCons "PosixString" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPosixString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortByteString)))

Methods

from :: PosixString -> Rep PosixString x

to :: Rep PosixString x -> PosixString

Show PosixString Source

Prints the raw bytes without decoding.
Instance details

Defined in System.OsString.Internal.Types

Methods

showsPrec :: Int -> PosixString -> ShowS

show :: PosixString -> String

showList :: [PosixString] -> ShowS

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

Lift PosixString Source
Instance details

Defined in System.OsString.Internal.Types

Methods

lift :: Quote m => PosixString -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => PosixString -> Code m PosixString

type Rep PosixString Source
Instance details

Defined in System.OsString.Internal.Types

type Rep PosixString = D1 ('MetaData "PosixString" "System.OsString.Internal.Types" "os-string-2.0.7-3f43" 'True) (C1 ('MetaCons "PosixString" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPosixString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortByteString)))

unPS :: PosixString -> ShortByteString Source

pattern PS :: ShortByteString -> PosixString Source

Just a short bidirectional synonym for PosixString constructor.

type PlatformString = PosixString Source

newtype WindowsChar Source

Constructors

WindowsChar

Fields

Instances
Instances details
NFData WindowsChar Source
Instance details

Defined in System.OsString.Internal.Types

Methods

rnf :: WindowsChar -> () Source

Generic WindowsChar Source
Instance details

Defined in System.OsString.Internal.Types

Associated Types

type Rep WindowsChar
Instance details

Defined in System.OsString.Internal.Types

type Rep WindowsChar = D1 ('MetaData "WindowsChar" "System.OsString.Internal.Types" "os-string-2.0.7-3f43" 'True) (C1 ('MetaCons "WindowsChar" 'PrefixI 'True) (S1 ('MetaSel ('Just "getWindowsChar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16)))

Methods

from :: WindowsChar -> Rep WindowsChar x

to :: Rep WindowsChar x -> WindowsChar

Show WindowsChar Source
Instance details

Defined in System.OsString.Internal.Types

Methods

showsPrec :: Int -> WindowsChar -> ShowS

show :: WindowsChar -> String

showList :: [WindowsChar] -> ShowS

Eq WindowsChar Source
Instance details

Defined in System.OsString.Internal.Types

Methods

(==) :: WindowsChar -> WindowsChar -> Bool

(/=) :: WindowsChar -> WindowsChar -> Bool

Ord WindowsChar Source
Instance details

Defined in System.OsString.Internal.Types

Methods

compare :: WindowsChar -> WindowsChar -> Ordering

(<) :: WindowsChar -> WindowsChar -> Bool

(<=) :: WindowsChar -> WindowsChar -> Bool

(>) :: WindowsChar -> WindowsChar -> Bool

(>=) :: WindowsChar -> WindowsChar -> Bool

max :: WindowsChar -> WindowsChar -> WindowsChar

min :: WindowsChar -> WindowsChar -> WindowsChar

type Rep WindowsChar Source
Instance details

Defined in System.OsString.Internal.Types

type Rep WindowsChar = D1 ('MetaData "WindowsChar" "System.OsString.Internal.Types" "os-string-2.0.7-3f43" 'True) (C1 ('MetaCons "WindowsChar" 'PrefixI 'True) (S1 ('MetaSel ('Just "getWindowsChar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16)))

unWW :: WindowsChar -> Word16 Source

pattern WW :: Word16 -> WindowsChar Source

Just a short bidirectional synonym for WindowsChar constructor.

newtype PosixChar Source

Constructors

PosixChar

Fields

Instances
Instances details
NFData PosixChar Source
Instance details

Defined in System.OsString.Internal.Types

Methods

rnf :: PosixChar -> () Source

Generic PosixChar Source
Instance details

Defined in System.OsString.Internal.Types

Associated Types

type Rep PosixChar
Instance details

Defined in System.OsString.Internal.Types

type Rep PosixChar = D1 ('MetaData "PosixChar" "System.OsString.Internal.Types" "os-string-2.0.7-3f43" 'True) (C1 ('MetaCons "PosixChar" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPosixChar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)))

Methods

from :: PosixChar -> Rep PosixChar x

to :: Rep PosixChar x -> PosixChar

Show PosixChar Source
Instance details

Defined in System.OsString.Internal.Types

Methods

showsPrec :: Int -> PosixChar -> ShowS

show :: PosixChar -> String

showList :: [PosixChar] -> ShowS

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

type Rep PosixChar Source
Instance details

Defined in System.OsString.Internal.Types

type Rep PosixChar = D1 ('MetaData "PosixChar" "System.OsString.Internal.Types" "os-string-2.0.7-3f43" 'True) (C1 ('MetaCons "PosixChar" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPosixChar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)))

unPW :: PosixChar -> Word8 Source

pattern PW :: Word8 -> PosixChar Source

Just a short bidirectional synonym for PosixChar constructor.

type PlatformChar = PosixChar Source

newtype OsString Source

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

Fields

Instances
Instances details
NFData OsString Source
Instance details

Defined in System.OsString.Internal.Types

Methods

rnf :: OsString -> () Source

Monoid OsString Source

"String-Concatenation" for OsString. This is not the same as (</>).
Instance details

Defined in System.OsString.Internal.Types

Methods

mempty :: OsString

mappend :: OsString -> OsString -> OsString

mconcat :: [OsString] -> OsString

Semigroup OsString Source
Instance details

Defined in System.OsString.Internal.Types

Methods

(<>) :: OsString -> OsString -> OsString

sconcat :: NonEmpty OsString -> OsString

stimes :: Integral b => b -> OsString -> OsString

Generic OsString Source
Instance details

Defined in System.OsString.Internal.Types

Associated Types

type Rep OsString
Instance details

Defined in System.OsString.Internal.Types

type Rep OsString = D1 ('MetaData "OsString" "System.OsString.Internal.Types" "os-string-2.0.7-3f43" 'True) (C1 ('MetaCons "OsString" 'PrefixI 'True) (S1 ('MetaSel ('Just "getOsString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PlatformString)))

Methods

from :: OsString -> Rep OsString x

to :: Rep OsString x -> OsString

Show OsString Source

On windows, decodes as UCS-2. On unix prints the raw bytes without decoding.
Instance details

Defined in System.OsString.Internal.Types

Methods

showsPrec :: Int -> OsString -> ShowS

show :: OsString -> String

showList :: [OsString] -> ShowS

Eq OsString Source

Byte equality of the internal representation.
Instance details

Defined in System.OsString.Internal.Types

Methods

(==) :: OsString -> OsString -> Bool

(/=) :: OsString -> OsString -> Bool

Ord OsString Source

Byte ordering of the internal representation.
Instance details

Defined in System.OsString.Internal.Types

Methods

compare :: OsString -> OsString -> Ordering

(<) :: OsString -> OsString -> Bool

(<=) :: OsString -> OsString -> Bool

(>) :: OsString -> OsString -> Bool

(>=) :: OsString -> OsString -> Bool

max :: OsString -> OsString -> OsString

min :: OsString -> OsString -> OsString

Lift OsString Source
Instance details

Defined in System.OsString.Internal.Types

Methods

lift :: Quote m => OsString -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => OsString -> Code m OsString

type Rep OsString Source
Instance details

Defined in System.OsString.Internal.Types

type Rep OsString = D1 ('MetaData "OsString" "System.OsString.Internal.Types" "os-string-2.0.7-3f43" 'True) (C1 ('MetaCons "OsString" 'PrefixI 'True) (S1 ('MetaSel ('Just "getOsString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PlatformString)))

newtype OsChar Source

Newtype representing a code unit.

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

Constructors

OsChar

Fields

Instances
Instances details
NFData OsChar Source
Instance details

Defined in System.OsString.Internal.Types

Methods

rnf :: OsChar -> () Source

Generic OsChar Source
Instance details

Defined in System.OsString.Internal.Types

Associated Types

type Rep OsChar
Instance details

Defined in System.OsString.Internal.Types

type Rep OsChar = D1 ('MetaData "OsChar" "System.OsString.Internal.Types" "os-string-2.0.7-3f43" 'True) (C1 ('MetaCons "OsChar" 'PrefixI 'True) (S1 ('MetaSel ('Just "getOsChar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PlatformChar)))

Methods

from :: OsChar -> Rep OsChar x

to :: Rep OsChar x -> OsChar

Show OsChar Source
Instance details

Defined in System.OsString.Internal.Types

Methods

showsPrec :: Int -> OsChar -> ShowS

show :: OsChar -> String

showList :: [OsChar] -> ShowS

Eq OsChar Source

Byte equality of the internal representation.
Instance details

Defined in System.OsString.Internal.Types

Methods

(==) :: OsChar -> OsChar -> Bool

(/=) :: OsChar -> OsChar -> Bool

Ord OsChar Source

Byte ordering of the internal representation.
Instance details

Defined in System.OsString.Internal.Types

Methods

compare :: OsChar -> OsChar -> Ordering

(<) :: OsChar -> OsChar -> Bool

(<=) :: OsChar -> OsChar -> Bool

(>) :: OsChar -> OsChar -> Bool

(>=) :: OsChar -> OsChar -> Bool

max :: OsChar -> OsChar -> OsChar

min :: OsChar -> OsChar -> OsChar

type Rep OsChar Source
Instance details

Defined in System.OsString.Internal.Types

type Rep OsChar = D1 ('MetaData "OsChar" "System.OsString.Internal.Types" "os-string-2.0.7-3f43" 'True) (C1 ('MetaCons "OsChar" 'PrefixI 'True) (S1 ('MetaSel ('Just "getOsChar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PlatformChar)))

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

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.

© The University of Glasgow and others
Licensed under a BSD-style license (see top of the page).
https://downloads.haskell.org/~ghc/9.12.1/docs/libraries/os-string-2.0.7-3f43/System-OsString-Internal-Types.html