GI.Gio.Objects.UnixInputStream

UnixInputStream implements InputStream for reading from 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/gunixinputstream.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 UnixInputStream

Memory-managed wrapper type.

Constructors

UnixInputStream (ManagedPtr UnixInputStream)

Instances

GObject UnixInputStream

Defined in GI.Gio.Objects.UnixInputStream

Methods

gobjectType :: IO GType

HasParentTypes UnixInputStream

Defined in GI.Gio.Objects.UnixInputStream

type ParentTypes UnixInputStream

Defined in GI.Gio.Objects.UnixInputStream

type ParentTypes UnixInputStream = InputStream ': (Object ': (FileDescriptorBased ': (PollableInputStream ': ([] :: [Type]))))

class (GObject o, IsDescendantOf UnixInputStream o) => IsUnixInputStream o

Type class for types which can be safely cast to UnixInputStream, for instance with toUnixInputStream.

Instances

(GObject o, IsDescendantOf UnixInputStream o) => IsUnixInputStream o

Defined in GI.Gio.Objects.UnixInputStream

toUnixInputStream :: (MonadIO m, IsUnixInputStream o) => o -> m UnixInputStream

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

noUnixInputStream :: Maybe UnixInputStream

A convenience alias for Nothing :: Maybe UnixInputStream.

Methods

getCloseFd

unixInputStreamGetCloseFd

Arguments

:: (HasCallStack, MonadIO m, IsUnixInputStream a)

=> a

stream: a UnixInputStream

-> 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

unixInputStreamGetFd

Arguments

:: (HasCallStack, MonadIO m, IsUnixInputStream a)

=> a

stream: a UnixInputStream

-> m Int32

Returns: The file descriptor of stream

Return the UNIX file descriptor that the stream reads from.

Since: 2.20

new

unixInputStreamNew

Arguments

:: (HasCallStack, MonadIO m)

=> Int32

fd: a UNIX file descriptor

-> Bool

closeFd: True to close the file descriptor when done

-> m UnixInputStream

Returns: a new UnixInputStream

Creates a new UnixInputStream for the given fd.

If closeFd is True, the file descriptor will be closed when the stream is closed.

setCloseFd

unixInputStreamSetCloseFd

Arguments

:: (HasCallStack, MonadIO m, IsUnixInputStream a)

=> a

stream: a UnixInputStream

-> 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

constructUnixInputStreamCloseFd :: IsUnixInputStream 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.

getUnixInputStreamCloseFd :: (MonadIO m, IsUnixInputStream o) => o -> m Bool

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

get unixInputStream #closeFd

setUnixInputStreamCloseFd :: (MonadIO m, IsUnixInputStream o) => o -> Bool -> m ()

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

set unixInputStream [ #closeFd := value ]

fd

The file descriptor that the stream reads from.

Since: 2.20

constructUnixInputStreamFd :: IsUnixInputStream 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.

getUnixInputStreamFd :: (MonadIO m, IsUnixInputStream o) => o -> m Int32

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

get unixInputStream #fd