System.OsString.Internal.Types

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

Documentation

newtype WindowsString

Commonly used windows string as wide character bytes.

Constructors

WindowsString

Fields

• getWindowsString :: ShortByteString

Instances

Monoid WindowsString

Defined in System.OsString.Internal.Types.Hidden

Methods

mempty :: WindowsString

mappend :: WindowsString -> WindowsString -> WindowsString

mconcat :: [WindowsString] -> WindowsString

Semigroup WindowsString

Defined in System.OsString.Internal.Types.Hidden

Methods

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

sconcat :: NonEmpty WindowsString -> WindowsString

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

Generic WindowsString

Defined in System.OsString.Internal.Types.Hidden

Associated Types

type Rep WindowsString :: Type -> Type

Methods

from :: WindowsString -> Rep WindowsString x

to :: Rep WindowsString x -> WindowsString

Show WindowsString

Decodes as UCS-2.

Defined in System.OsString.Internal.Types.Hidden

Methods

showsPrec :: Int -> WindowsString -> ShowS

show :: WindowsString -> String

showList :: [WindowsString] -> ShowS

NFData WindowsString

Defined in System.OsString.Internal.Types.Hidden

Methods

rnf :: WindowsString -> ()

Eq WindowsString

Defined in System.OsString.Internal.Types.Hidden

Methods

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

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

Ord WindowsString

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

Defined in System.OsString.Internal.Types.Hidden

Methods

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

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

type Rep WindowsString

Defined in System.OsString.Internal.Types.Hidden

type Rep WindowsString = D1 ('MetaData "WindowsString" "System.OsString.Internal.Types.Hidden" "filepath-1.4.300.1-inplace" 'True) (C1 ('MetaCons "WindowsString" 'PrefixI 'True) (S1 ('MetaSel ('Just "getWindowsString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortByteString)))

pattern WS :: ShortByteString -> WindowsString

Just a short bidirectional synonym for WindowsString constructor.

unWS :: WindowsString -> ShortByteString

newtype PosixString

Commonly used Posix string as uninterpreted char[] array.

Constructors

PosixString

Fields

• getPosixString :: ShortByteString

Instances

Monoid PosixString

Defined in System.OsString.Internal.Types.Hidden

Methods

mempty :: PosixString

mappend :: PosixString -> PosixString -> PosixString

mconcat :: [PosixString] -> PosixString

Semigroup PosixString

Defined in System.OsString.Internal.Types.Hidden

Methods

(<>) :: PosixString -> PosixString -> PosixString

sconcat :: NonEmpty PosixString -> PosixString

stimes :: Integral b => b -> PosixString -> PosixString

Generic PosixString

Defined in System.OsString.Internal.Types.Hidden

Associated Types

type Rep PosixString :: Type -> Type

Methods

from :: PosixString -> Rep PosixString x

to :: Rep PosixString x -> PosixString

Show PosixString

Prints the raw bytes without decoding.

Defined in System.OsString.Internal.Types.Hidden

Methods

showsPrec :: Int -> PosixString -> ShowS

show :: PosixString -> String

showList :: [PosixString] -> ShowS

NFData PosixString

Defined in System.OsString.Internal.Types.Hidden

Methods

rnf :: PosixString -> ()

Eq PosixString

Defined in System.OsString.Internal.Types.Hidden

Methods

(==) :: PosixString -> PosixString -> Bool

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

Ord PosixString

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

Defined in System.OsString.Internal.Types.Hidden

Methods

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

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

type Rep PosixString

Defined in System.OsString.Internal.Types.Hidden

type Rep PosixString = D1 ('MetaData "PosixString" "System.OsString.Internal.Types.Hidden" "filepath-1.4.300.1-inplace" 'True) (C1 ('MetaCons "PosixString" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPosixString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortByteString)))

unPS :: PosixString -> ShortByteString

pattern PS :: ShortByteString -> PosixString

Just a short bidirectional synonym for PosixString constructor.

type PlatformString = PosixString

newtype WindowsChar

Constructors

WindowsChar

Fields

• getWindowsChar :: Word16

Instances

Generic WindowsChar

Defined in System.OsString.Internal.Types.Hidden

Associated Types

type Rep WindowsChar :: Type -> Type

Methods

from :: WindowsChar -> Rep WindowsChar x

to :: Rep WindowsChar x -> WindowsChar

Show WindowsChar

Defined in System.OsString.Internal.Types.Hidden

Methods

showsPrec :: Int -> WindowsChar -> ShowS

show :: WindowsChar -> String

showList :: [WindowsChar] -> ShowS

NFData WindowsChar

Defined in System.OsString.Internal.Types.Hidden

Methods

rnf :: WindowsChar -> ()

Eq WindowsChar

Defined in System.OsString.Internal.Types.Hidden

Methods

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

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

Ord WindowsChar

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

Defined in System.OsString.Internal.Types.Hidden

type Rep WindowsChar = D1 ('MetaData "WindowsChar" "System.OsString.Internal.Types.Hidden" "filepath-1.4.300.1-inplace" 'True) (C1 ('MetaCons "WindowsChar" 'PrefixI 'True) (S1 ('MetaSel ('Just "getWindowsChar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16)))

unWW :: WindowsChar -> Word16

pattern WW :: Word16 -> WindowsChar

Just a short bidirectional synonym for WindowsChar constructor.

newtype PosixChar

Constructors

PosixChar

Fields

• getPosixChar :: Word8

Instances

Generic PosixChar

Defined in System.OsString.Internal.Types.Hidden

Associated Types

type Rep PosixChar :: Type -> Type

Methods

from :: PosixChar -> Rep PosixChar x

to :: Rep PosixChar x -> PosixChar

Show PosixChar

Defined in System.OsString.Internal.Types.Hidden

Methods

showsPrec :: Int -> PosixChar -> ShowS

show :: PosixChar -> String

showList :: [PosixChar] -> ShowS

NFData PosixChar

Defined in System.OsString.Internal.Types.Hidden

Methods

rnf :: PosixChar -> ()

Eq PosixChar

Defined in System.OsString.Internal.Types.Hidden

Methods

(==) :: PosixChar -> PosixChar -> Bool

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

Ord PosixChar

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

Defined in System.OsString.Internal.Types.Hidden

type Rep PosixChar = D1 ('MetaData "PosixChar" "System.OsString.Internal.Types.Hidden" "filepath-1.4.300.1-inplace" 'True) (C1 ('MetaCons "PosixChar" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPosixChar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)))

unPW :: PosixChar -> Word8

pattern PW :: Word8 -> PosixChar

Just a short bidirectional synonym for PosixChar constructor.

type PlatformChar = PosixChar

newtype 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

Fields

• getOsString :: PlatformString

Instances

Monoid OsString

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

Defined in System.OsString.Internal.Types.Hidden

Methods

mempty :: OsString

mappend :: OsString -> OsString -> OsString

mconcat :: [OsString] -> OsString

Semigroup OsString

Defined in System.OsString.Internal.Types.Hidden

Methods

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

sconcat :: NonEmpty OsString -> OsString

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

Generic OsString

Defined in System.OsString.Internal.Types.Hidden

Associated Types

type Rep OsString :: Type -> Type

Methods

from :: OsString -> Rep OsString x

to :: Rep OsString x -> OsString

Show OsString

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

Defined in System.OsString.Internal.Types.Hidden

Methods

showsPrec :: Int -> OsString -> ShowS

show :: OsString -> String

showList :: [OsString] -> ShowS

NFData OsString

Defined in System.OsString.Internal.Types.Hidden

Methods

rnf :: OsString -> ()

Eq OsString

Byte equality of the internal representation.

Defined in System.OsString.Internal.Types.Hidden

Methods

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

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

Ord OsString

Byte ordering of the internal representation.

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

Defined in System.OsString.Internal.Types.Hidden

Methods

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

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

type Rep OsString

Defined in System.OsString.Internal.Types.Hidden

type Rep OsString = D1 ('MetaData "OsString" "System.OsString.Internal.Types.Hidden" "filepath-1.4.300.1-inplace" 'True) (C1 ('MetaCons "OsString" 'PrefixI 'True) (S1 ('MetaSel ('Just "getOsString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PlatformString)))

newtype OsChar

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

Generic OsChar

Defined in System.OsString.Internal.Types.Hidden

Associated Types

type Rep OsChar :: Type -> Type

Methods

from :: OsChar -> Rep OsChar x

to :: Rep OsChar x -> OsChar

Show OsChar

Defined in System.OsString.Internal.Types.Hidden

Methods

showsPrec :: Int -> OsChar -> ShowS

show :: OsChar -> String

showList :: [OsChar] -> ShowS

NFData OsChar

Defined in System.OsString.Internal.Types.Hidden

Methods

rnf :: OsChar -> ()

Eq OsChar

Byte equality of the internal representation.

Defined in System.OsString.Internal.Types.Hidden

Methods

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

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

Ord OsChar

Byte ordering of the internal representation.

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

Defined in System.OsString.Internal.Types.Hidden

type Rep OsChar = D1 ('MetaData "OsChar" "System.OsString.Internal.Types.Hidden" "filepath-1.4.300.1-inplace" 'True) (C1 ('MetaCons "OsChar" 'PrefixI 'True) (S1 ('MetaSel ('Just "getOsChar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PlatformChar)))