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

Constructors

UnixInputStream (ManagedPtr UnixInputStream)

Instances

GObject UnixInputStream

Methods

gobjectType :: UnixInputStream -> IO GType

IsObject UnixInputStream

IsInputStream UnixInputStream

IsPollableInputStream UnixInputStream

IsFileDescriptorBased UnixInputStream

IsUnixInputStream UnixInputStream

((~) * info (ResolveUnixInputStreamMethod t UnixInputStream), MethodInfo * info UnixInputStream p) => IsLabel t (UnixInputStream -> p)

Methods

fromLabel :: Proxy# Symbol t -> UnixInputStream -> p

((~) * info (ResolveUnixInputStreamMethod t UnixInputStream), MethodInfo * info UnixInputStream p) => IsLabelProxy t (UnixInputStream -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> UnixInputStream -> p

HasAttributeList * UnixInputStream

type AttributeList UnixInputStream

type AttributeList UnixInputStream

type SignalList UnixInputStream

type SignalList UnixInputStream

class GObject o => IsUnixInputStream o

Instances

(GObject a, UnknownAncestorError Constraint UnixInputStream a) => IsUnixInputStream a

IsUnixInputStream UnixInputStream

toUnixInputStream :: IsUnixInputStream o => o -> IO UnixInputStream

noUnixInputStream :: Maybe UnixInputStream

Methods

getCloseFd

data UnixInputStreamGetCloseFdMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsUnixInputStream a) => MethodInfo * UnixInputStreamGetCloseFdMethodInfo a signature

Methods

overloadedMethod :: MethodProxy UnixInputStreamGetCloseFdMethodInfo a -> signature -> s

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

data UnixInputStreamGetFdMethodInfo

Instances

((~) * signature (m Int32), MonadIO m, IsUnixInputStream a) => MethodInfo * UnixInputStreamGetFdMethodInfo a signature

Methods

overloadedMethod :: MethodProxy UnixInputStreamGetFdMethodInfo a -> signature -> s

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

data UnixInputStreamSetCloseFdMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsUnixInputStream a) => MethodInfo * UnixInputStreamSetCloseFdMethodInfo a signature

Methods

overloadedMethod :: MethodProxy UnixInputStreamSetCloseFdMethodInfo a -> signature -> s

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

data UnixInputStreamCloseFdPropertyInfo

Instances

AttrInfo UnixInputStreamCloseFdPropertyInfo

Associated Types

type AttrAllowedOps UnixInputStreamCloseFdPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint UnixInputStreamCloseFdPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint UnixInputStreamCloseFdPropertyInfo :: * -> Constraint

type AttrGetType UnixInputStreamCloseFdPropertyInfo :: *

type AttrLabel UnixInputStreamCloseFdPropertyInfo :: Symbol

type AttrOrigin UnixInputStreamCloseFdPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint UnixInputStreamCloseFdPropertyInfo o => Proxy * UnixInputStreamCloseFdPropertyInfo -> o -> IO (AttrGetType UnixInputStreamCloseFdPropertyInfo)

attrSet :: (AttrBaseTypeConstraint UnixInputStreamCloseFdPropertyInfo o, AttrSetTypeConstraint UnixInputStreamCloseFdPropertyInfo b) => Proxy * UnixInputStreamCloseFdPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint UnixInputStreamCloseFdPropertyInfo o => Proxy * UnixInputStreamCloseFdPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint UnixInputStreamCloseFdPropertyInfo o, AttrSetTypeConstraint UnixInputStreamCloseFdPropertyInfo b) => Proxy * UnixInputStreamCloseFdPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin UnixInputStreamCloseFdPropertyInfo

type AttrOrigin UnixInputStreamCloseFdPropertyInfo = UnixInputStream

type AttrLabel UnixInputStreamCloseFdPropertyInfo

type AttrLabel UnixInputStreamCloseFdPropertyInfo = "close-fd"

type AttrGetType UnixInputStreamCloseFdPropertyInfo

type AttrGetType UnixInputStreamCloseFdPropertyInfo = Bool

type AttrBaseTypeConstraint UnixInputStreamCloseFdPropertyInfo

type AttrBaseTypeConstraint UnixInputStreamCloseFdPropertyInfo = IsUnixInputStream

type AttrSetTypeConstraint UnixInputStreamCloseFdPropertyInfo

type AttrSetTypeConstraint UnixInputStreamCloseFdPropertyInfo = * ~ Bool

type AttrAllowedOps UnixInputStreamCloseFdPropertyInfo

type AttrAllowedOps UnixInputStreamCloseFdPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructUnixInputStreamCloseFd :: IsUnixInputStream o => Bool -> IO (GValueConstruct o)

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

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

unixInputStreamCloseFd :: AttrLabelProxy "closeFd"

fd

data UnixInputStreamFdPropertyInfo

Instances

AttrInfo UnixInputStreamFdPropertyInfo

Associated Types

type AttrAllowedOps UnixInputStreamFdPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint UnixInputStreamFdPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint UnixInputStreamFdPropertyInfo :: * -> Constraint

type AttrGetType UnixInputStreamFdPropertyInfo :: *

type AttrLabel UnixInputStreamFdPropertyInfo :: Symbol

type AttrOrigin UnixInputStreamFdPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint UnixInputStreamFdPropertyInfo o => Proxy * UnixInputStreamFdPropertyInfo -> o -> IO (AttrGetType UnixInputStreamFdPropertyInfo)

attrSet :: (AttrBaseTypeConstraint UnixInputStreamFdPropertyInfo o, AttrSetTypeConstraint UnixInputStreamFdPropertyInfo b) => Proxy * UnixInputStreamFdPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint UnixInputStreamFdPropertyInfo o => Proxy * UnixInputStreamFdPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint UnixInputStreamFdPropertyInfo o, AttrSetTypeConstraint UnixInputStreamFdPropertyInfo b) => Proxy * UnixInputStreamFdPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin UnixInputStreamFdPropertyInfo

type AttrOrigin UnixInputStreamFdPropertyInfo = UnixInputStream

type AttrLabel UnixInputStreamFdPropertyInfo

type AttrLabel UnixInputStreamFdPropertyInfo = "fd"

type AttrGetType UnixInputStreamFdPropertyInfo

type AttrGetType UnixInputStreamFdPropertyInfo = Int32

type AttrBaseTypeConstraint UnixInputStreamFdPropertyInfo

type AttrBaseTypeConstraint UnixInputStreamFdPropertyInfo = IsUnixInputStream

type AttrSetTypeConstraint UnixInputStreamFdPropertyInfo

type AttrSetTypeConstraint UnixInputStreamFdPropertyInfo = * ~ Int32

type AttrAllowedOps UnixInputStreamFdPropertyInfo

type AttrAllowedOps UnixInputStreamFdPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag))

constructUnixInputStreamFd :: IsUnixInputStream o => Int32 -> IO (GValueConstruct o)

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

unixInputStreamFd :: AttrLabelProxy "fd"