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

Constructors

UnixOutputStream (ManagedPtr UnixOutputStream)

Instances

GObject UnixOutputStream

Methods

gobjectType :: UnixOutputStream -> IO GType

IsObject UnixOutputStream

IsOutputStream UnixOutputStream

IsPollableOutputStream UnixOutputStream

IsFileDescriptorBased UnixOutputStream

IsUnixOutputStream UnixOutputStream

((~) * info (ResolveUnixOutputStreamMethod t UnixOutputStream), MethodInfo * info UnixOutputStream p) => IsLabel t (UnixOutputStream -> p)

Methods

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

((~) * info (ResolveUnixOutputStreamMethod t UnixOutputStream), MethodInfo * info UnixOutputStream p) => IsLabelProxy t (UnixOutputStream -> p)

Methods

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

HasAttributeList * UnixOutputStream

type AttributeList UnixOutputStream

type AttributeList UnixOutputStream

type SignalList UnixOutputStream

type SignalList UnixOutputStream

class GObject o => IsUnixOutputStream o

Instances

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

IsUnixOutputStream UnixOutputStream

toUnixOutputStream :: IsUnixOutputStream o => o -> IO UnixOutputStream

noUnixOutputStream :: Maybe UnixOutputStream

Methods

getCloseFd

data UnixOutputStreamGetCloseFdMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsUnixOutputStream a) => MethodInfo * UnixOutputStreamGetCloseFdMethodInfo a signature

Methods

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

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

data UnixOutputStreamGetFdMethodInfo

Instances

((~) * signature (m Int32), MonadIO m, IsUnixOutputStream a) => MethodInfo * UnixOutputStreamGetFdMethodInfo a signature

Methods

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

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

data UnixOutputStreamSetCloseFdMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m, IsUnixOutputStream a) => MethodInfo * UnixOutputStreamSetCloseFdMethodInfo a signature

Methods

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

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

data UnixOutputStreamCloseFdPropertyInfo

Instances

AttrInfo UnixOutputStreamCloseFdPropertyInfo

Associated Types

type AttrAllowedOps UnixOutputStreamCloseFdPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint UnixOutputStreamCloseFdPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint UnixOutputStreamCloseFdPropertyInfo :: * -> Constraint

type AttrGetType UnixOutputStreamCloseFdPropertyInfo :: *

type AttrLabel UnixOutputStreamCloseFdPropertyInfo :: Symbol

type AttrOrigin UnixOutputStreamCloseFdPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin UnixOutputStreamCloseFdPropertyInfo

type AttrOrigin UnixOutputStreamCloseFdPropertyInfo = UnixOutputStream

type AttrLabel UnixOutputStreamCloseFdPropertyInfo

type AttrLabel UnixOutputStreamCloseFdPropertyInfo = "close-fd"

type AttrGetType UnixOutputStreamCloseFdPropertyInfo

type AttrGetType UnixOutputStreamCloseFdPropertyInfo = Bool

type AttrBaseTypeConstraint UnixOutputStreamCloseFdPropertyInfo

type AttrBaseTypeConstraint UnixOutputStreamCloseFdPropertyInfo = IsUnixOutputStream

type AttrSetTypeConstraint UnixOutputStreamCloseFdPropertyInfo

type AttrSetTypeConstraint UnixOutputStreamCloseFdPropertyInfo = * ~ Bool

type AttrAllowedOps UnixOutputStreamCloseFdPropertyInfo

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

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"

fd

data UnixOutputStreamFdPropertyInfo

Instances

AttrInfo UnixOutputStreamFdPropertyInfo

Associated Types

type AttrAllowedOps UnixOutputStreamFdPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint UnixOutputStreamFdPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint UnixOutputStreamFdPropertyInfo :: * -> Constraint

type AttrGetType UnixOutputStreamFdPropertyInfo :: *

type AttrLabel UnixOutputStreamFdPropertyInfo :: Symbol

type AttrOrigin UnixOutputStreamFdPropertyInfo :: *

Methods

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

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

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

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

type AttrOrigin UnixOutputStreamFdPropertyInfo

type AttrOrigin UnixOutputStreamFdPropertyInfo = UnixOutputStream

type AttrLabel UnixOutputStreamFdPropertyInfo

type AttrLabel UnixOutputStreamFdPropertyInfo = "fd"

type AttrGetType UnixOutputStreamFdPropertyInfo

type AttrGetType UnixOutputStreamFdPropertyInfo = Int32

type AttrBaseTypeConstraint UnixOutputStreamFdPropertyInfo

type AttrBaseTypeConstraint UnixOutputStreamFdPropertyInfo = IsUnixOutputStream

type AttrSetTypeConstraint UnixOutputStreamFdPropertyInfo

type AttrSetTypeConstraint UnixOutputStreamFdPropertyInfo = * ~ Int32

type AttrAllowedOps UnixOutputStreamFdPropertyInfo

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

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

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

unixOutputStreamFd :: AttrLabelProxy "fd"