| Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.GLib.Structs.IOChannel
Contents
- Exported types
- Methods
- close
- errorFromErrno
- errorQuark
- flush
- getBufferCondition
- getBufferSize
- getBuffered
- getCloseOnUnref
- getEncoding
- getFlags
- getLineTerm
- init
- newFile
- read
- readChars
- readLine
- readToEnd
- readUnichar
- ref
- seek
- seekPosition
- setBufferSize
- setBuffered
- setCloseOnUnref
- setEncoding
- setFlags
- setLineTerm
- shutdown
- unixGetFd
- unixNew
- unref
- write
- writeChars
- writeUnichar
Description
A data structure representing an IO Channel. The fields should be considered private and should only be accessed with the following functions.
- newtype IOChannel = IOChannel (ManagedPtr IOChannel)
- newZeroIOChannel :: MonadIO m => m IOChannel
- noIOChannel :: Maybe IOChannel
- data IOChannelCloseMethodInfo
- iOChannelClose :: MonadIO m => IOChannel -> m ()
- iOChannelErrorFromErrno :: MonadIO m => Int32 -> m IOChannelError
- iOChannelErrorQuark :: MonadIO m => m Word32
- data IOChannelFlushMethodInfo
- iOChannelFlush :: MonadIO m => IOChannel -> m IOStatus
- data IOChannelGetBufferConditionMethodInfo
- iOChannelGetBufferCondition :: MonadIO m => IOChannel -> m [IOCondition]
- data IOChannelGetBufferSizeMethodInfo
- iOChannelGetBufferSize :: MonadIO m => IOChannel -> m Word64
- data IOChannelGetBufferedMethodInfo
- iOChannelGetBuffered :: MonadIO m => IOChannel -> m Bool
- data IOChannelGetCloseOnUnrefMethodInfo
- iOChannelGetCloseOnUnref :: MonadIO m => IOChannel -> m Bool
- data IOChannelGetEncodingMethodInfo
- iOChannelGetEncoding :: MonadIO m => IOChannel -> m Text
- data IOChannelGetFlagsMethodInfo
- iOChannelGetFlags :: MonadIO m => IOChannel -> m [IOFlags]
- data IOChannelGetLineTermMethodInfo
- iOChannelGetLineTerm :: MonadIO m => IOChannel -> Int32 -> m Text
- data IOChannelInitMethodInfo
- iOChannelInit :: MonadIO m => IOChannel -> m ()
- iOChannelNewFile :: MonadIO m => Text -> Text -> m IOChannel
- data IOChannelReadMethodInfo
- iOChannelRead :: MonadIO m => IOChannel -> Text -> Word64 -> Word64 -> m IOError
- data IOChannelReadCharsMethodInfo
- iOChannelReadChars :: MonadIO m => IOChannel -> ByteString -> m (IOStatus, ByteString, Word64)
- data IOChannelReadLineMethodInfo
- iOChannelReadLine :: MonadIO m => IOChannel -> m (IOStatus, Text, Word64, Word64)
- data IOChannelReadToEndMethodInfo
- iOChannelReadToEnd :: MonadIO m => IOChannel -> m (IOStatus, ByteString)
- data IOChannelReadUnicharMethodInfo
- iOChannelReadUnichar :: MonadIO m => IOChannel -> m (IOStatus, Char)
- data IOChannelRefMethodInfo
- iOChannelRef :: MonadIO m => IOChannel -> m IOChannel
- data IOChannelSeekMethodInfo
- iOChannelSeek :: MonadIO m => IOChannel -> Int64 -> SeekType -> m IOError
- data IOChannelSeekPositionMethodInfo
- iOChannelSeekPosition :: MonadIO m => IOChannel -> Int64 -> SeekType -> m IOStatus
- data IOChannelSetBufferSizeMethodInfo
- iOChannelSetBufferSize :: MonadIO m => IOChannel -> Word64 -> m ()
- data IOChannelSetBufferedMethodInfo
- iOChannelSetBuffered :: MonadIO m => IOChannel -> Bool -> m ()
- data IOChannelSetCloseOnUnrefMethodInfo
- iOChannelSetCloseOnUnref :: MonadIO m => IOChannel -> Bool -> m ()
- data IOChannelSetEncodingMethodInfo
- iOChannelSetEncoding :: MonadIO m => IOChannel -> Maybe Text -> m IOStatus
- data IOChannelSetFlagsMethodInfo
- iOChannelSetFlags :: MonadIO m => IOChannel -> [IOFlags] -> m IOStatus
- data IOChannelSetLineTermMethodInfo
- iOChannelSetLineTerm :: MonadIO m => IOChannel -> Maybe Text -> Int32 -> m ()
- data IOChannelShutdownMethodInfo
- iOChannelShutdown :: MonadIO m => IOChannel -> Bool -> m IOStatus
- data IOChannelUnixGetFdMethodInfo
- iOChannelUnixGetFd :: MonadIO m => IOChannel -> m Int32
- iOChannelUnixNew :: MonadIO m => Int32 -> m IOChannel
- data IOChannelUnrefMethodInfo
- iOChannelUnref :: MonadIO m => IOChannel -> m ()
- data IOChannelWriteMethodInfo
- iOChannelWrite :: MonadIO m => IOChannel -> Text -> Word64 -> Word64 -> m IOError
- data IOChannelWriteCharsMethodInfo
- iOChannelWriteChars :: MonadIO m => IOChannel -> Ptr Word8 -> Int64 -> m (IOStatus, Word64)
- data IOChannelWriteUnicharMethodInfo
- iOChannelWriteUnichar :: MonadIO m => IOChannel -> Char -> m IOStatus
Exported types
Instances
| BoxedObject IOChannel Source # | |
| (~) AttrOpTag tag AttrSet => Constructible IOChannel tag Source # | |
| ((~) * info (ResolveIOChannelMethod t IOChannel), MethodInfo * info IOChannel p) => IsLabel t (IOChannel -> p) Source # | |
| ((~) * info (ResolveIOChannelMethod t IOChannel), MethodInfo * info IOChannel p) => IsLabelProxy t (IOChannel -> p) Source # | |
| HasAttributeList * IOChannel Source # | |
| ((~) * signature (Char -> m IOStatus), MonadIO m) => MethodInfo * IOChannelWriteUnicharMethodInfo IOChannel signature Source # | |
| ((~) * signature (Ptr Word8 -> Int64 -> m (IOStatus, Word64)), MonadIO m) => MethodInfo * IOChannelWriteCharsMethodInfo IOChannel signature Source # | |
| ((~) * signature (Text -> Word64 -> Word64 -> m IOError), MonadIO m) => MethodInfo * IOChannelWriteMethodInfo IOChannel signature Source # | |
| ((~) * signature (m ()), MonadIO m) => MethodInfo * IOChannelUnrefMethodInfo IOChannel signature Source # | |
| ((~) * signature (m Int32), MonadIO m) => MethodInfo * IOChannelUnixGetFdMethodInfo IOChannel signature Source # | |
| ((~) * signature (Bool -> m IOStatus), MonadIO m) => MethodInfo * IOChannelShutdownMethodInfo IOChannel signature Source # | |
| ((~) * signature (Maybe Text -> Int32 -> m ()), MonadIO m) => MethodInfo * IOChannelSetLineTermMethodInfo IOChannel signature Source # | |
| ((~) * signature ([IOFlags] -> m IOStatus), MonadIO m) => MethodInfo * IOChannelSetFlagsMethodInfo IOChannel signature Source # | |
| ((~) * signature (Maybe Text -> m IOStatus), MonadIO m) => MethodInfo * IOChannelSetEncodingMethodInfo IOChannel signature Source # | |
| ((~) * signature (Bool -> m ()), MonadIO m) => MethodInfo * IOChannelSetCloseOnUnrefMethodInfo IOChannel signature Source # | |
| ((~) * signature (Bool -> m ()), MonadIO m) => MethodInfo * IOChannelSetBufferedMethodInfo IOChannel signature Source # | |
| ((~) * signature (Word64 -> m ()), MonadIO m) => MethodInfo * IOChannelSetBufferSizeMethodInfo IOChannel signature Source # | |
| ((~) * signature (Int64 -> SeekType -> m IOStatus), MonadIO m) => MethodInfo * IOChannelSeekPositionMethodInfo IOChannel signature Source # | |
| ((~) * signature (Int64 -> SeekType -> m IOError), MonadIO m) => MethodInfo * IOChannelSeekMethodInfo IOChannel signature Source # | |
| ((~) * signature (m IOChannel), MonadIO m) => MethodInfo * IOChannelRefMethodInfo IOChannel signature Source # | |
| ((~) * signature (m (IOStatus, Char)), MonadIO m) => MethodInfo * IOChannelReadUnicharMethodInfo IOChannel signature Source # | |
| ((~) * signature (m (IOStatus, ByteString)), MonadIO m) => MethodInfo * IOChannelReadToEndMethodInfo IOChannel signature Source # | |
| ((~) * signature (m (IOStatus, Text, Word64, Word64)), MonadIO m) => MethodInfo * IOChannelReadLineMethodInfo IOChannel signature Source # | |
| ((~) * signature (ByteString -> m (IOStatus, ByteString, Word64)), MonadIO m) => MethodInfo * IOChannelReadCharsMethodInfo IOChannel signature Source # | |
| ((~) * signature (Text -> Word64 -> Word64 -> m IOError), MonadIO m) => MethodInfo * IOChannelReadMethodInfo IOChannel signature Source # | |
| ((~) * signature (m ()), MonadIO m) => MethodInfo * IOChannelInitMethodInfo IOChannel signature Source # | |
| ((~) * signature (Int32 -> m Text), MonadIO m) => MethodInfo * IOChannelGetLineTermMethodInfo IOChannel signature Source # | |
| ((~) * signature (m [IOFlags]), MonadIO m) => MethodInfo * IOChannelGetFlagsMethodInfo IOChannel signature Source # | |
| ((~) * signature (m Text), MonadIO m) => MethodInfo * IOChannelGetEncodingMethodInfo IOChannel signature Source # | |
| ((~) * signature (m Bool), MonadIO m) => MethodInfo * IOChannelGetCloseOnUnrefMethodInfo IOChannel signature Source # | |
| ((~) * signature (m Bool), MonadIO m) => MethodInfo * IOChannelGetBufferedMethodInfo IOChannel signature Source # | |
| ((~) * signature (m Word64), MonadIO m) => MethodInfo * IOChannelGetBufferSizeMethodInfo IOChannel signature Source # | |
| ((~) * signature (m [IOCondition]), MonadIO m) => MethodInfo * IOChannelGetBufferConditionMethodInfo IOChannel signature Source # | |
| ((~) * signature (m IOStatus), MonadIO m) => MethodInfo * IOChannelFlushMethodInfo IOChannel signature Source # | |
| ((~) * signature (m ()), MonadIO m) => MethodInfo * IOChannelCloseMethodInfo IOChannel signature Source # | |
| type AttributeList IOChannel Source # | |
newZeroIOChannel :: MonadIO m => m IOChannel Source #
Construct a IOChannel struct initialized to zero.
Methods
close
iOChannelClose :: MonadIO m => IOChannel -> m () Source #
Deprecated: (Since version 2.2)Use g_io_channel_shutdown() instead.
errorFromErrno
iOChannelErrorFromErrno :: MonadIO m => Int32 -> m IOChannelError Source #
errorQuark
iOChannelErrorQuark :: MonadIO m => m Word32 Source #
flush
getBufferCondition
data IOChannelGetBufferConditionMethodInfo Source #
Instances
| ((~) * signature (m [IOCondition]), MonadIO m) => MethodInfo * IOChannelGetBufferConditionMethodInfo IOChannel signature Source # | |
iOChannelGetBufferCondition :: MonadIO m => IOChannel -> m [IOCondition] Source #
getBufferSize
getBuffered
getCloseOnUnref
getEncoding
iOChannelGetEncoding :: MonadIO m => IOChannel -> m Text Source #
getFlags
getLineTerm
init
iOChannelInit :: MonadIO m => IOChannel -> m () Source #
newFile
iOChannelNewFile :: MonadIO m => Text -> Text -> m IOChannel Source #
read
iOChannelRead :: MonadIO m => IOChannel -> Text -> Word64 -> Word64 -> m IOError Source #
Deprecated: (Since version 2.2)Use g_io_channel_read_chars() instead.
readChars
data IOChannelReadCharsMethodInfo Source #
Instances
| ((~) * signature (ByteString -> m (IOStatus, ByteString, Word64)), MonadIO m) => MethodInfo * IOChannelReadCharsMethodInfo IOChannel signature Source # | |
iOChannelReadChars :: MonadIO m => IOChannel -> ByteString -> m (IOStatus, ByteString, Word64) Source #
readLine
readToEnd
data IOChannelReadToEndMethodInfo Source #
Instances
| ((~) * signature (m (IOStatus, ByteString)), MonadIO m) => MethodInfo * IOChannelReadToEndMethodInfo IOChannel signature Source # | |
iOChannelReadToEnd :: MonadIO m => IOChannel -> m (IOStatus, ByteString) Source #
readUnichar
ref
seek
iOChannelSeek :: MonadIO m => IOChannel -> Int64 -> SeekType -> m IOError Source #
Deprecated: (Since version 2.2)Use g_io_channel_seek_position() instead.
seekPosition
setBufferSize
setBuffered
setCloseOnUnref
setEncoding
setFlags
setLineTerm
shutdown
unixGetFd
unixNew
unref
iOChannelUnref :: MonadIO m => IOChannel -> m () Source #
write
iOChannelWrite :: MonadIO m => IOChannel -> Text -> Word64 -> Word64 -> m IOError Source #
Deprecated: (Since version 2.2)Use g_io_channel_write_chars() instead.
writeChars
iOChannelWriteChars :: MonadIO m => IOChannel -> Ptr Word8 -> Int64 -> m (IOStatus, Word64) Source #