Safe Haskell	Safe-Inferred
Language	Haskell2010

System.OsString.Internal.Types

Description

Deprecated: Use System.OsString.Internal.Types from os-string >= 2.0.0 package instead. This module will be removed in filepath >= 1.5.

Synopsis

newtype WindowsString = WindowsString {
- getWindowsString :: ShortByteString
}
pattern WS :: ShortByteString -> WindowsString
unWS :: WindowsString -> ShortByteString
newtype PosixString = PosixString {
- getPosixString :: ShortByteString
}
unPS :: PosixString -> ShortByteString
pattern PS :: ShortByteString -> PosixString
type PlatformString = PosixString
newtype WindowsChar = WindowsChar {
- getWindowsChar :: Word16
}
unWW :: WindowsChar -> Word16
pattern WW :: Word16 -> WindowsChar
newtype PosixChar = PosixChar {
- getPosixChar :: Word8
}
unPW :: PosixChar -> Word8
pattern PW :: Word8 -> PosixChar
type PlatformChar = PosixChar
newtype OsString = OsString {
- getOsString :: PlatformString
}
newtype OsChar = OsChar {
- getOsChar :: PlatformChar
}

Documentation

newtype WindowsString Source #

Commonly used windows string as wide character bytes.

Constructors

WindowsString
Fields getWindowsString :: ShortByteString

Instances

Instances details

Monoid WindowsString Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Methods mempty :: WindowsString Source # mappend :: WindowsString -> WindowsString -> WindowsString Source # mconcat :: [WindowsString] -> WindowsString Source #
Semigroup WindowsString Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Methods (<>) :: WindowsString -> WindowsString -> WindowsString Source # sconcat :: NonEmpty WindowsString -> WindowsString Source # stimes :: Integral b => b -> WindowsString -> WindowsString Source #
Generic WindowsString Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Associated Types type Rep WindowsString :: Type -> Type Source # Methods from :: WindowsString -> Rep WindowsString x Source # to :: Rep WindowsString x -> WindowsString Source #
Show WindowsString Source #	Decodes as UCS-2.
Instance details Defined in System.OsString.Internal.Types.Hidden Methods showsPrec :: Int -> WindowsString -> ShowS Source # show :: WindowsString -> String Source # showList :: [WindowsString] -> ShowS Source #
NFData WindowsString Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Methods rnf :: WindowsString -> () Source #
Eq WindowsString Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Methods (==) :: WindowsString -> WindowsString -> Bool # (/=) :: WindowsString -> WindowsString -> Bool #
Ord WindowsString Source #
Instance details Defined in System.OsString.Internal.Types.Hidden 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.Hidden Methods lift :: Quote m => WindowsString -> m Exp Source # liftTyped :: forall (m :: Type -> Type). Quote m => WindowsString -> Code m WindowsString Source #
type Rep WindowsString Source #
Instance details Defined in System.OsString.Internal.Types.Hidden type Rep WindowsString = D1 ('MetaData "WindowsString" "System.OsString.Internal.Types.Hidden" "filepath-1.4.200.1" '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 getPosixString :: ShortByteString

Instances

Instances details

Monoid PosixString Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Methods mempty :: PosixString Source # mappend :: PosixString -> PosixString -> PosixString Source # mconcat :: [PosixString] -> PosixString Source #
Semigroup PosixString Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Methods (<>) :: PosixString -> PosixString -> PosixString Source # sconcat :: NonEmpty PosixString -> PosixString Source # stimes :: Integral b => b -> PosixString -> PosixString Source #
Generic PosixString Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Associated Types type Rep PosixString :: Type -> Type Source # Methods from :: PosixString -> Rep PosixString x Source # to :: Rep PosixString x -> PosixString Source #
Show PosixString Source #	Prints the raw bytes without decoding.
Instance details Defined in System.OsString.Internal.Types.Hidden Methods showsPrec :: Int -> PosixString -> ShowS Source # show :: PosixString -> String Source # showList :: [PosixString] -> ShowS Source #
NFData PosixString Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Methods rnf :: PosixString -> () Source #
Eq PosixString Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Methods (==) :: PosixString -> PosixString -> Bool # (/=) :: PosixString -> PosixString -> Bool #
Ord PosixString Source #
Instance details Defined in System.OsString.Internal.Types.Hidden 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.Hidden Methods lift :: Quote m => PosixString -> m Exp Source # liftTyped :: forall (m :: Type -> Type). Quote m => PosixString -> Code m PosixString Source #
type Rep PosixString Source #
Instance details Defined in System.OsString.Internal.Types.Hidden type Rep PosixString = D1 ('MetaData "PosixString" "System.OsString.Internal.Types.Hidden" "filepath-1.4.200.1" '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 getWindowsChar :: Word16

Instances

Instances details

Generic WindowsChar Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Associated Types type Rep WindowsChar :: Type -> Type Source # Methods from :: WindowsChar -> Rep WindowsChar x Source # to :: Rep WindowsChar x -> WindowsChar Source #
Show WindowsChar Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Methods showsPrec :: Int -> WindowsChar -> ShowS Source # show :: WindowsChar -> String Source # showList :: [WindowsChar] -> ShowS Source #
NFData WindowsChar Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Methods rnf :: WindowsChar -> () Source #
Eq WindowsChar Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Methods (==) :: WindowsChar -> WindowsChar -> Bool # (/=) :: WindowsChar -> WindowsChar -> Bool #
Ord WindowsChar Source #
Instance details Defined in System.OsString.Internal.Types.Hidden 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.Hidden type Rep WindowsChar = D1 ('MetaData "WindowsChar" "System.OsString.Internal.Types.Hidden" "filepath-1.4.200.1" '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 getPosixChar :: Word8

Instances

Instances details

Generic PosixChar Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Associated Types type Rep PosixChar :: Type -> Type Source # Methods from :: PosixChar -> Rep PosixChar x Source # to :: Rep PosixChar x -> PosixChar Source #
Show PosixChar Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Methods showsPrec :: Int -> PosixChar -> ShowS Source # show :: PosixChar -> String Source # showList :: [PosixChar] -> ShowS Source #
NFData PosixChar Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Methods rnf :: PosixChar -> () Source #
Eq PosixChar Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Methods (==) :: PosixChar -> PosixChar -> Bool # (/=) :: PosixChar -> PosixChar -> Bool #
Ord PosixChar Source #
Instance details Defined in System.OsString.Internal.Types.Hidden 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.Hidden type Rep PosixChar = D1 ('MetaData "PosixChar" "System.OsString.Internal.Types.Hidden" "filepath-1.4.200.1" '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 getOsString :: PlatformString

Instances

Instances details

Monoid OsString Source #	"String-Concatenation" for `OsString`. This is not the same as `(</>)`.
Instance details Defined in System.OsString.Internal.Types.Hidden Methods mempty :: OsString Source # mappend :: OsString -> OsString -> OsString Source # mconcat :: [OsString] -> OsString Source #
Semigroup OsString Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Methods (<>) :: OsString -> OsString -> OsString Source # sconcat :: NonEmpty OsString -> OsString Source # stimes :: Integral b => b -> OsString -> OsString Source #
Generic OsString Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Associated Types type Rep OsString :: Type -> Type Source # Methods from :: OsString -> Rep OsString x Source # to :: Rep OsString x -> OsString Source #
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.Hidden Methods showsPrec :: Int -> OsString -> ShowS Source # show :: OsString -> String Source # showList :: [OsString] -> ShowS Source #
NFData OsString Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Methods rnf :: OsString -> () Source #
Eq OsString Source #	Byte equality of the internal representation.
Instance details Defined in System.OsString.Internal.Types.Hidden Methods (==) :: OsString -> OsString -> Bool # (/=) :: OsString -> OsString -> Bool #
Ord OsString Source #	Byte ordering of the internal representation.
Instance details Defined in System.OsString.Internal.Types.Hidden 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.Hidden Methods lift :: Quote m => OsString -> m Exp Source # liftTyped :: forall (m :: Type -> Type). Quote m => OsString -> Code m OsString Source #
type Rep OsString Source #
Instance details Defined in System.OsString.Internal.Types.Hidden type Rep OsString = D1 ('MetaData "OsString" "System.OsString.Internal.Types.Hidden" "filepath-1.4.200.1" '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 getOsChar :: PlatformChar

Instances

Instances details

Generic OsChar Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Associated Types type Rep OsChar :: Type -> Type Source # Methods from :: OsChar -> Rep OsChar x Source # to :: Rep OsChar x -> OsChar Source #
Show OsChar Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Methods showsPrec :: Int -> OsChar -> ShowS Source # show :: OsChar -> String Source # showList :: [OsChar] -> ShowS Source #
NFData OsChar Source #
Instance details Defined in System.OsString.Internal.Types.Hidden Methods rnf :: OsChar -> () Source #
Eq OsChar Source #	Byte equality of the internal representation.
Instance details Defined in System.OsString.Internal.Types.Hidden Methods (==) :: OsChar -> OsChar -> Bool # (/=) :: OsChar -> OsChar -> Bool #
Ord OsChar Source #	Byte ordering of the internal representation.
Instance details Defined in System.OsString.Internal.Types.Hidden 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.Hidden type Rep OsChar = D1 ('MetaData "OsChar" "System.OsString.Internal.Types.Hidden" "filepath-1.4.200.1" 'True) (C1 ('MetaCons "OsChar" 'PrefixI 'True) (S1 ('MetaSel ('Just "getOsChar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PlatformChar)))