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 |
UnixOutputStream
implements OutputStream
for writing to a UNIX
file descriptor, including asynchronous operations. (If the file
descriptor refers to a socket or pipe, this will use poll()
to do
asynchronous I/O. If it refers to a regular file, it will fall back
to doing asynchronous I/O in another thread.)
Note that <gio/gunixoutputstream.h>
belongs to the UNIX-specific GIO
interfaces, thus you have to use the gio-unix-2.0.pc
pkg-config file
when using it.
- newtype UnixOutputStream = UnixOutputStream (ManagedPtr UnixOutputStream)
- class GObject o => IsUnixOutputStream o
- toUnixOutputStream :: IsUnixOutputStream o => o -> IO UnixOutputStream
- noUnixOutputStream :: Maybe UnixOutputStream
- data UnixOutputStreamGetCloseFdMethodInfo
- unixOutputStreamGetCloseFd :: (HasCallStack, MonadIO m, IsUnixOutputStream a) => a -> m Bool
- data UnixOutputStreamGetFdMethodInfo
- unixOutputStreamGetFd :: (HasCallStack, MonadIO m, IsUnixOutputStream a) => a -> m Int32
- unixOutputStreamNew :: (HasCallStack, MonadIO m) => Int32 -> Bool -> m UnixOutputStream
- data UnixOutputStreamSetCloseFdMethodInfo
- unixOutputStreamSetCloseFd :: (HasCallStack, MonadIO m, IsUnixOutputStream a) => a -> Bool -> m ()
- data UnixOutputStreamCloseFdPropertyInfo
- constructUnixOutputStreamCloseFd :: IsUnixOutputStream o => Bool -> IO (GValueConstruct o)
- getUnixOutputStreamCloseFd :: (MonadIO m, IsUnixOutputStream o) => o -> m Bool
- setUnixOutputStreamCloseFd :: (MonadIO m, IsUnixOutputStream o) => o -> Bool -> m ()
- unixOutputStreamCloseFd :: AttrLabelProxy "closeFd"
- data UnixOutputStreamFdPropertyInfo
- constructUnixOutputStreamFd :: IsUnixOutputStream o => Int32 -> IO (GValueConstruct o)
- getUnixOutputStreamFd :: (MonadIO m, IsUnixOutputStream o) => o -> m Int32
- unixOutputStreamFd :: AttrLabelProxy "fd"
Exported types
newtype UnixOutputStream Source #
GObject UnixOutputStream Source # | |
IsObject UnixOutputStream Source # | |
IsOutputStream UnixOutputStream Source # | |
IsPollableOutputStream UnixOutputStream Source # | |
IsFileDescriptorBased UnixOutputStream Source # | |
IsUnixOutputStream UnixOutputStream Source # | |
((~) * info (ResolveUnixOutputStreamMethod t UnixOutputStream), MethodInfo * info UnixOutputStream p) => IsLabel t (UnixOutputStream -> p) Source # | |
((~) * info (ResolveUnixOutputStreamMethod t UnixOutputStream), MethodInfo * info UnixOutputStream p) => IsLabelProxy t (UnixOutputStream -> p) Source # | |
HasAttributeList * UnixOutputStream Source # | |
type AttributeList UnixOutputStream Source # | |
type SignalList UnixOutputStream Source # | |
class GObject o => IsUnixOutputStream o Source #
toUnixOutputStream :: IsUnixOutputStream o => o -> IO UnixOutputStream Source #
Methods
getCloseFd
data UnixOutputStreamGetCloseFdMethodInfo Source #
((~) * signature (m Bool), MonadIO m, IsUnixOutputStream a) => MethodInfo * UnixOutputStreamGetCloseFdMethodInfo a signature Source # | |
unixOutputStreamGetCloseFd Source #
:: (HasCallStack, MonadIO m, IsUnixOutputStream a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether the file descriptor of stream
will be
closed when the stream is closed.
Since: 2.20
getFd
data UnixOutputStreamGetFdMethodInfo Source #
((~) * signature (m Int32), MonadIO m, IsUnixOutputStream a) => MethodInfo * UnixOutputStreamGetFdMethodInfo a signature Source # | |
unixOutputStreamGetFd Source #
:: (HasCallStack, MonadIO m, IsUnixOutputStream a) | |
=> a |
|
-> m Int32 | Returns: The file descriptor of |
Return the UNIX file descriptor that the stream writes to.
Since: 2.20
new
:: (HasCallStack, MonadIO m) | |
=> Int32 |
|
-> Bool |
|
-> m UnixOutputStream | Returns: a new |
Creates a new UnixOutputStream
for the given fd
.
If closeFd
, is True
, the file descriptor will be closed when
the output stream is destroyed.
setCloseFd
data UnixOutputStreamSetCloseFdMethodInfo Source #
((~) * signature (Bool -> m ()), MonadIO m, IsUnixOutputStream a) => MethodInfo * UnixOutputStreamSetCloseFdMethodInfo a signature Source # | |
unixOutputStreamSetCloseFd Source #
:: (HasCallStack, MonadIO m, IsUnixOutputStream a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the file descriptor of stream
shall be closed
when the stream is closed.
Since: 2.20
Properties
closeFd
data UnixOutputStreamCloseFdPropertyInfo Source #
constructUnixOutputStreamCloseFd :: IsUnixOutputStream o => Bool -> IO (GValueConstruct o) Source #
getUnixOutputStreamCloseFd :: (MonadIO m, IsUnixOutputStream o) => o -> m Bool Source #
setUnixOutputStreamCloseFd :: (MonadIO m, IsUnixOutputStream o) => o -> Bool -> m () Source #
unixOutputStreamCloseFd :: AttrLabelProxy "closeFd" Source #
fd
data UnixOutputStreamFdPropertyInfo Source #
constructUnixOutputStreamFd :: IsUnixOutputStream o => Int32 -> IO (GValueConstruct o) Source #
getUnixOutputStreamFd :: (MonadIO m, IsUnixOutputStream o) => o -> m Int32 Source #
unixOutputStreamFd :: AttrLabelProxy "fd" Source #