GI.Gio.Objects.UnixOutputStream

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.

Exported types

newtype UnixOutputStream

Memory-managed wrapper type.

Constructors

UnixOutputStream (ManagedPtr UnixOutputStream)

Instances

GObject UnixOutputStream

Defined in GI.Gio.Objects.UnixOutputStream

Methods

gobjectType :: UnixOutputStream -> IO GType

IsObject UnixOutputStream

Defined in GI.Gio.Objects.UnixOutputStream

IsFileDescriptorBased UnixOutputStream

Defined in GI.Gio.Objects.UnixOutputStream

IsPollableOutputStream UnixOutputStream

Defined in GI.Gio.Objects.UnixOutputStream

IsOutputStream UnixOutputStream

Defined in GI.Gio.Objects.UnixOutputStream

IsUnixOutputStream UnixOutputStream

Defined in GI.Gio.Objects.UnixOutputStream

class GObject o => IsUnixOutputStream o

Type class for types which can be safely cast to UnixOutputStream, for instance with toUnixOutputStream.

Instances

(GObject a, (UnknownAncestorError UnixOutputStream a :: Constraint)) => IsUnixOutputStream a

Defined in GI.Gio.Objects.UnixOutputStream

IsUnixOutputStream UnixOutputStream

Defined in GI.Gio.Objects.UnixOutputStream

toUnixOutputStream :: (MonadIO m, IsUnixOutputStream o) => o -> m UnixOutputStream

Cast to UnixOutputStream, for types for which this is known to be safe. For general casts, use castTo.

noUnixOutputStream :: Maybe UnixOutputStream

A convenience alias for Nothing :: Maybe UnixOutputStream.

Methods

getCloseFd

unixOutputStreamGetCloseFd

Arguments

:: (HasCallStack, MonadIO m, IsUnixOutputStream a)

=> a

stream: a UnixOutputStream

-> m Bool

Returns: True if the file descriptor is closed when done

Returns whether the file descriptor of stream will be closed when the stream is closed.

Since: 2.20

getFd

unixOutputStreamGetFd

Arguments

:: (HasCallStack, MonadIO m, IsUnixOutputStream a)

=> a

stream: a UnixOutputStream

-> m Int32

Returns: The file descriptor of stream

Return the UNIX file descriptor that the stream writes to.

Since: 2.20

new

unixOutputStreamNew

Arguments

:: (HasCallStack, MonadIO m)

=> Int32

fd: a UNIX file descriptor

-> Bool

closeFd: True to close the file descriptor when done

-> m UnixOutputStream

Returns: a new OutputStream

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

unixOutputStreamSetCloseFd

Arguments

:: (HasCallStack, MonadIO m, IsUnixOutputStream a)

=> a

stream: a UnixOutputStream

-> Bool

closeFd: True to close the file descriptor when done

-> m ()

Sets whether the file descriptor of stream shall be closed when the stream is closed.

Since: 2.20

Properties

closeFd

Whether to close the file descriptor when the stream is closed.

Since: 2.20

constructUnixOutputStreamCloseFd :: IsUnixOutputStream o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “close-fd” property. This is rarely needed directly, but it is used by new.

getUnixOutputStreamCloseFd :: (MonadIO m, IsUnixOutputStream o) => o -> m Bool

Get the value of the “close-fd” property. When overloading is enabled, this is equivalent to

get unixOutputStream #closeFd

setUnixOutputStreamCloseFd :: (MonadIO m, IsUnixOutputStream o) => o -> Bool -> m ()

Set the value of the “close-fd” property. When overloading is enabled, this is equivalent to

set unixOutputStream [ #closeFd := value ]

fd

The file descriptor that the stream writes to.

Since: 2.20

constructUnixOutputStreamFd :: IsUnixOutputStream o => Int32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “fd” property. This is rarely needed directly, but it is used by new.

getUnixOutputStreamFd :: (MonadIO m, IsUnixOutputStream o) => o -> m Int32

Get the value of the “fd” property. When overloading is enabled, this is equivalent to

get unixOutputStream #fd