Copyright	(c) The University of Glasgow 2017
License	see libraries/base/LICENSE
Maintainer	libraries@haskell.org
Stability	internal
Portability	non-portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

GHC.IO.Windows.Handle

Contents

Basic Types
Utility functions
Standard Handles
File utilities

Description

Raw read/write operations on Windows Handles

Synopsis

data NativeHandle
data ConsoleHandle
data IoHandle a
type HANDLE = Ptr ()
type Io a = IoHandle a
convertHandle :: Io ConsoleHandle -> Bool -> Io NativeHandle
toHANDLE :: RawHandle a => a -> HANDLE
fromHANDLE :: RawHandle a => HANDLE -> a
handleToMode :: HANDLE -> IO IOMode
isAsynchronous :: IoHandle NativeHandle -> Bool
optimizeFileAccess :: HANDLE -> IO ()
stdin :: Io ConsoleHandle
stdout :: Io ConsoleHandle
stderr :: Io ConsoleHandle
openFile :: FilePath -> IOMode -> Bool -> IO (Io NativeHandle, IODeviceType)
openFileAsTemp :: FilePath -> Bool -> Bool -> IO (Io NativeHandle, IODeviceType)
release :: RawHandle a => a -> IO ()

Basic Types

data NativeHandle Source #

Instances

Instances details

BufferedIO (Io NativeHandle) Source #	See librariesbaseGHCIOBufferedIO.hs Since: base-4.11.0.0
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods newBuffer :: Io NativeHandle -> BufferState -> IO (Buffer Word8) Source # fillReadBuffer :: Io NativeHandle -> Buffer Word8 -> IO (Int, Buffer Word8) Source # fillReadBuffer0 :: Io NativeHandle -> Buffer Word8 -> IO (Maybe Int, Buffer Word8) Source # emptyWriteBuffer :: Io NativeHandle -> Buffer Word8 -> IO (Buffer Word8) Source # flushWriteBuffer :: Io NativeHandle -> Buffer Word8 -> IO (Buffer Word8) Source # flushWriteBuffer0 :: Io NativeHandle -> Buffer Word8 -> IO (Int, Buffer Word8) Source #
IODevice (Io NativeHandle) Source #	Since: base-4.11.0.0
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods ready :: Io NativeHandle -> Bool -> Int -> IO Bool Source # close :: Io NativeHandle -> IO () Source # isTerminal :: Io NativeHandle -> IO Bool Source # isSeekable :: Io NativeHandle -> IO Bool Source # seek :: Io NativeHandle -> SeekMode -> Integer -> IO Integer Source # tell :: Io NativeHandle -> IO Integer Source # getSize :: Io NativeHandle -> IO Integer Source # setSize :: Io NativeHandle -> Integer -> IO () Source # setEcho :: Io NativeHandle -> Bool -> IO () Source # getEcho :: Io NativeHandle -> IO Bool Source # setRaw :: Io NativeHandle -> Bool -> IO () Source # devType :: Io NativeHandle -> IO IODeviceType Source # dup :: Io NativeHandle -> IO (Io NativeHandle) Source # dup2 :: Io NativeHandle -> Io NativeHandle -> IO (Io NativeHandle) Source #
RawIO (Io NativeHandle) Source #	Since: base-4.11.0.0
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods read :: Io NativeHandle -> Ptr Word8 -> Word64 -> Int -> IO Int Source # readNonBlocking :: Io NativeHandle -> Ptr Word8 -> Word64 -> Int -> IO (Maybe Int) Source # write :: Io NativeHandle -> Ptr Word8 -> Word64 -> Int -> IO () Source # writeNonBlocking :: Io NativeHandle -> Ptr Word8 -> Word64 -> Int -> IO Int Source #
RawHandle (Io NativeHandle)
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods toHANDLE :: Io NativeHandle -> HANDLE Source # fromHANDLE :: HANDLE -> Io NativeHandle Source # isLockable :: Io NativeHandle -> Bool setCooked :: Io NativeHandle -> Bool -> IO (Io NativeHandle) isCooked :: Io NativeHandle -> IO Bool
Show (Io NativeHandle) Source #	Since: base-4.11.0.0
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods showsPrec :: Int -> Io NativeHandle -> ShowS Source # show :: Io NativeHandle -> String Source # showList :: [Io NativeHandle] -> ShowS Source #

data ConsoleHandle Source #

Instances

Instances details

BufferedIO (Io ConsoleHandle) Source #	See librariesbaseGHCIOBufferedIO.hs Since: base-4.11.0.0
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods newBuffer :: Io ConsoleHandle -> BufferState -> IO (Buffer Word8) Source # fillReadBuffer :: Io ConsoleHandle -> Buffer Word8 -> IO (Int, Buffer Word8) Source # fillReadBuffer0 :: Io ConsoleHandle -> Buffer Word8 -> IO (Maybe Int, Buffer Word8) Source # emptyWriteBuffer :: Io ConsoleHandle -> Buffer Word8 -> IO (Buffer Word8) Source # flushWriteBuffer :: Io ConsoleHandle -> Buffer Word8 -> IO (Buffer Word8) Source # flushWriteBuffer0 :: Io ConsoleHandle -> Buffer Word8 -> IO (Int, Buffer Word8) Source #
IODevice (Io ConsoleHandle) Source #	Since: base-4.11.0.0
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods ready :: Io ConsoleHandle -> Bool -> Int -> IO Bool Source # close :: Io ConsoleHandle -> IO () Source # isTerminal :: Io ConsoleHandle -> IO Bool Source # isSeekable :: Io ConsoleHandle -> IO Bool Source # seek :: Io ConsoleHandle -> SeekMode -> Integer -> IO Integer Source # tell :: Io ConsoleHandle -> IO Integer Source # getSize :: Io ConsoleHandle -> IO Integer Source # setSize :: Io ConsoleHandle -> Integer -> IO () Source # setEcho :: Io ConsoleHandle -> Bool -> IO () Source # getEcho :: Io ConsoleHandle -> IO Bool Source # setRaw :: Io ConsoleHandle -> Bool -> IO () Source # devType :: Io ConsoleHandle -> IO IODeviceType Source # dup :: Io ConsoleHandle -> IO (Io ConsoleHandle) Source # dup2 :: Io ConsoleHandle -> Io ConsoleHandle -> IO (Io ConsoleHandle) Source #
RawIO (Io ConsoleHandle) Source #	Since: base-4.11.0.0
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods read :: Io ConsoleHandle -> Ptr Word8 -> Word64 -> Int -> IO Int Source # readNonBlocking :: Io ConsoleHandle -> Ptr Word8 -> Word64 -> Int -> IO (Maybe Int) Source # write :: Io ConsoleHandle -> Ptr Word8 -> Word64 -> Int -> IO () Source # writeNonBlocking :: Io ConsoleHandle -> Ptr Word8 -> Word64 -> Int -> IO Int Source #
RawHandle (Io ConsoleHandle)
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods toHANDLE :: Io ConsoleHandle -> HANDLE Source # fromHANDLE :: HANDLE -> Io ConsoleHandle Source # isLockable :: Io ConsoleHandle -> Bool setCooked :: Io ConsoleHandle -> Bool -> IO (Io ConsoleHandle) isCooked :: Io ConsoleHandle -> IO Bool
Show (Io ConsoleHandle) Source #	Since: base-4.11.0.0
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods showsPrec :: Int -> Io ConsoleHandle -> ShowS Source # show :: Io ConsoleHandle -> String Source # showList :: [Io ConsoleHandle] -> ShowS Source #

data IoHandle a Source #

Bit of a Hack, but we don't want every handle to have a cooked entry but all copies of the handles for which we do want one need to share the same value. We can't store it separately because we don't know when the handle will be destroyed or invalidated.

Instances

Instances details

BufferedIO (Io ConsoleHandle) Source #	See librariesbaseGHCIOBufferedIO.hs Since: base-4.11.0.0
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods newBuffer :: Io ConsoleHandle -> BufferState -> IO (Buffer Word8) Source # fillReadBuffer :: Io ConsoleHandle -> Buffer Word8 -> IO (Int, Buffer Word8) Source # fillReadBuffer0 :: Io ConsoleHandle -> Buffer Word8 -> IO (Maybe Int, Buffer Word8) Source # emptyWriteBuffer :: Io ConsoleHandle -> Buffer Word8 -> IO (Buffer Word8) Source # flushWriteBuffer :: Io ConsoleHandle -> Buffer Word8 -> IO (Buffer Word8) Source # flushWriteBuffer0 :: Io ConsoleHandle -> Buffer Word8 -> IO (Int, Buffer Word8) Source #
BufferedIO (Io NativeHandle) Source #	See librariesbaseGHCIOBufferedIO.hs Since: base-4.11.0.0
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods newBuffer :: Io NativeHandle -> BufferState -> IO (Buffer Word8) Source # fillReadBuffer :: Io NativeHandle -> Buffer Word8 -> IO (Int, Buffer Word8) Source # fillReadBuffer0 :: Io NativeHandle -> Buffer Word8 -> IO (Maybe Int, Buffer Word8) Source # emptyWriteBuffer :: Io NativeHandle -> Buffer Word8 -> IO (Buffer Word8) Source # flushWriteBuffer :: Io NativeHandle -> Buffer Word8 -> IO (Buffer Word8) Source # flushWriteBuffer0 :: Io NativeHandle -> Buffer Word8 -> IO (Int, Buffer Word8) Source #
IODevice (Io ConsoleHandle) Source #	Since: base-4.11.0.0
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods ready :: Io ConsoleHandle -> Bool -> Int -> IO Bool Source # close :: Io ConsoleHandle -> IO () Source # isTerminal :: Io ConsoleHandle -> IO Bool Source # isSeekable :: Io ConsoleHandle -> IO Bool Source # seek :: Io ConsoleHandle -> SeekMode -> Integer -> IO Integer Source # tell :: Io ConsoleHandle -> IO Integer Source # getSize :: Io ConsoleHandle -> IO Integer Source # setSize :: Io ConsoleHandle -> Integer -> IO () Source # setEcho :: Io ConsoleHandle -> Bool -> IO () Source # getEcho :: Io ConsoleHandle -> IO Bool Source # setRaw :: Io ConsoleHandle -> Bool -> IO () Source # devType :: Io ConsoleHandle -> IO IODeviceType Source # dup :: Io ConsoleHandle -> IO (Io ConsoleHandle) Source # dup2 :: Io ConsoleHandle -> Io ConsoleHandle -> IO (Io ConsoleHandle) Source #
IODevice (Io NativeHandle) Source #	Since: base-4.11.0.0
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods ready :: Io NativeHandle -> Bool -> Int -> IO Bool Source # close :: Io NativeHandle -> IO () Source # isTerminal :: Io NativeHandle -> IO Bool Source # isSeekable :: Io NativeHandle -> IO Bool Source # seek :: Io NativeHandle -> SeekMode -> Integer -> IO Integer Source # tell :: Io NativeHandle -> IO Integer Source # getSize :: Io NativeHandle -> IO Integer Source # setSize :: Io NativeHandle -> Integer -> IO () Source # setEcho :: Io NativeHandle -> Bool -> IO () Source # getEcho :: Io NativeHandle -> IO Bool Source # setRaw :: Io NativeHandle -> Bool -> IO () Source # devType :: Io NativeHandle -> IO IODeviceType Source # dup :: Io NativeHandle -> IO (Io NativeHandle) Source # dup2 :: Io NativeHandle -> Io NativeHandle -> IO (Io NativeHandle) Source #
RawIO (Io ConsoleHandle) Source #	Since: base-4.11.0.0
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods read :: Io ConsoleHandle -> Ptr Word8 -> Word64 -> Int -> IO Int Source # readNonBlocking :: Io ConsoleHandle -> Ptr Word8 -> Word64 -> Int -> IO (Maybe Int) Source # write :: Io ConsoleHandle -> Ptr Word8 -> Word64 -> Int -> IO () Source # writeNonBlocking :: Io ConsoleHandle -> Ptr Word8 -> Word64 -> Int -> IO Int Source #
RawIO (Io NativeHandle) Source #	Since: base-4.11.0.0
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods read :: Io NativeHandle -> Ptr Word8 -> Word64 -> Int -> IO Int Source # readNonBlocking :: Io NativeHandle -> Ptr Word8 -> Word64 -> Int -> IO (Maybe Int) Source # write :: Io NativeHandle -> Ptr Word8 -> Word64 -> Int -> IO () Source # writeNonBlocking :: Io NativeHandle -> Ptr Word8 -> Word64 -> Int -> IO Int Source #
RawHandle (Io ConsoleHandle)
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods toHANDLE :: Io ConsoleHandle -> HANDLE Source # fromHANDLE :: HANDLE -> Io ConsoleHandle Source # isLockable :: Io ConsoleHandle -> Bool setCooked :: Io ConsoleHandle -> Bool -> IO (Io ConsoleHandle) isCooked :: Io ConsoleHandle -> IO Bool
RawHandle (Io NativeHandle)
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods toHANDLE :: Io NativeHandle -> HANDLE Source # fromHANDLE :: HANDLE -> Io NativeHandle Source # isLockable :: Io NativeHandle -> Bool setCooked :: Io NativeHandle -> Bool -> IO (Io NativeHandle) isCooked :: Io NativeHandle -> IO Bool
Show (Io ConsoleHandle) Source #	Since: base-4.11.0.0
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods showsPrec :: Int -> Io ConsoleHandle -> ShowS Source # show :: Io ConsoleHandle -> String Source # showList :: [Io ConsoleHandle] -> ShowS Source #
Show (Io NativeHandle) Source #	Since: base-4.11.0.0
Instance details Defined in GHC.Internal.IO.Windows.Handle Methods showsPrec :: Int -> Io NativeHandle -> ShowS Source # show :: Io NativeHandle -> String Source # showList :: [Io NativeHandle] -> ShowS Source #

type HANDLE = Ptr () Source #

type Io a = IoHandle a Source #

Utility functions

convertHandle :: Io ConsoleHandle -> Bool -> Io NativeHandle Source #

Convert a ConsoleHandle into a general FileHandle This will change which DeviceIO is used.

toHANDLE :: RawHandle a => a -> HANDLE Source #

fromHANDLE :: RawHandle a => HANDLE -> a Source #

handleToMode :: HANDLE -> IO IOMode Source #

isAsynchronous :: IoHandle NativeHandle -> Bool Source #

optimizeFileAccess :: HANDLE -> IO () Source #

Standard Handles

stdin :: Io ConsoleHandle Source #

stdout :: Io ConsoleHandle Source #

stderr :: Io ConsoleHandle Source #

File utilities

openFile Source #

Arguments

:: FilePath	file to open
-> IOMode	mode in which to open the file
-> Bool	open the file in non-blocking mode?
-> IO (Io NativeHandle, IODeviceType)

Open a file and make an NativeHandle for it. Truncates the file to zero size when the IOMode is WriteMode.

openFileAsTemp Source #

Arguments

:: FilePath	file to open
-> Bool	open the file in non-blocking mode?
-> Bool	Exclusive mode
-> IO (Io NativeHandle, IODeviceType)

Open a file as a temporary file and make an NativeHandle for it. Truncates the file to zero size when the IOMode is WriteMode.

release :: RawHandle a => a -> IO () Source #