gi-gio
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Gio.Interfaces.FileDescriptorBased

Description

GFileDescriptorBased is an interface for file descriptor based IO.

It is implemented by streams (implementations of InputStream or OutputStream) that are based on file descriptors.

Note that <gio/gfiledescriptorbased.h> belongs to the UNIX-specific GIO interfaces, thus you have to use the gio-unix-2.0.pc pkg-config file or the GioUnix-2.0 GIR namespace when using it.

Since: 2.24

Synopsis

Exported types

newtype FileDescriptorBased Source #

Memory-managed wrapper type.

Constructors

FileDescriptorBased (ManagedPtr FileDescriptorBased) 

Instances

Instances details
Eq FileDescriptorBased Source # 
Instance details

Defined in GI.Gio.Interfaces.FileDescriptorBased

Methods

(==) :: FileDescriptorBased -> FileDescriptorBased -> Bool #

(/=) :: FileDescriptorBased -> FileDescriptorBased -> Bool #

GObject FileDescriptorBased Source # 
Instance details

Defined in GI.Gio.Interfaces.FileDescriptorBased

ManagedPtrNewtype FileDescriptorBased Source # 
Instance details

Defined in GI.Gio.Interfaces.FileDescriptorBased

Methods

toManagedPtr :: FileDescriptorBased -> ManagedPtr FileDescriptorBased #

TypedObject FileDescriptorBased Source # 
Instance details

Defined in GI.Gio.Interfaces.FileDescriptorBased

Methods

glibType :: IO GType #

HasParentTypes FileDescriptorBased Source # 
Instance details

Defined in GI.Gio.Interfaces.FileDescriptorBased

HasAttributeList FileDescriptorBased Source # 
Instance details

Defined in GI.Gio.Interfaces.FileDescriptorBased

(info ~ ResolveFileDescriptorBasedMethod t FileDescriptorBased, OverloadedMethod info FileDescriptorBased p, HasField t FileDescriptorBased p) => HasField (t :: Symbol) FileDescriptorBased (p :: Type) Source # 
Instance details

Defined in GI.Gio.Interfaces.FileDescriptorBased

Methods

getField :: FileDescriptorBased -> p #

(info ~ ResolveFileDescriptorBasedMethod t FileDescriptorBased, OverloadedMethodInfo info FileDescriptorBased) => IsLabel t (MethodProxy info FileDescriptorBased) Source # 
Instance details

Defined in GI.Gio.Interfaces.FileDescriptorBased

Methods

fromLabel :: MethodProxy info FileDescriptorBased #

(info ~ ResolveFileDescriptorBasedMethod t FileDescriptorBased, OverloadedMethod info FileDescriptorBased p) => IsLabel t (FileDescriptorBased -> p) Source # 
Instance details

Defined in GI.Gio.Interfaces.FileDescriptorBased

Methods

fromLabel :: FileDescriptorBased -> p #

IsGValue (Maybe FileDescriptorBased) Source #

Convert FileDescriptorBased to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.Gio.Interfaces.FileDescriptorBased

Methods

gvalueGType_ :: IO GType #

gvalueSet_ :: Ptr GValue -> Maybe FileDescriptorBased -> IO () #

gvalueGet_ :: Ptr GValue -> IO (Maybe FileDescriptorBased) #

type AttributeList FileDescriptorBased Source # 
Instance details

Defined in GI.Gio.Interfaces.FileDescriptorBased

type AttributeList FileDescriptorBased
type ParentTypes FileDescriptorBased Source # 
Instance details

Defined in GI.Gio.Interfaces.FileDescriptorBased

type ParentTypes FileDescriptorBased = '[Object]
type SignalList FileDescriptorBased Source # 
Instance details

Defined in GI.Gio.Interfaces.FileDescriptorBased

type SignalList FileDescriptorBased

class (GObject o, IsDescendantOf FileDescriptorBased o) => IsFileDescriptorBased o Source #

Type class for types which can be safely cast to FileDescriptorBased, for instance with toFileDescriptorBased.

Instances

Instances details
(GObject o, IsDescendantOf FileDescriptorBased o) => IsFileDescriptorBased o Source # 
Instance details

Defined in GI.Gio.Interfaces.FileDescriptorBased

toFileDescriptorBased :: (MonadIO m, IsFileDescriptorBased o) => o -> m FileDescriptorBased Source #

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

Methods

Click to display all available methods, including inherited ones

Expand

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getFd, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

type family ResolveFileDescriptorBasedMethod (t :: Symbol) o where ... Source #

Equations

ResolveFileDescriptorBasedMethod "bindProperty" o = ObjectBindPropertyMethodInfo 
ResolveFileDescriptorBasedMethod "bindPropertyFull" o = ObjectBindPropertyFullMethodInfo 
ResolveFileDescriptorBasedMethod "forceFloating" o = ObjectForceFloatingMethodInfo 
ResolveFileDescriptorBasedMethod "freezeNotify" o = ObjectFreezeNotifyMethodInfo 
ResolveFileDescriptorBasedMethod "getv" o = ObjectGetvMethodInfo 
ResolveFileDescriptorBasedMethod "isFloating" o = ObjectIsFloatingMethodInfo 
ResolveFileDescriptorBasedMethod "notify" o = ObjectNotifyMethodInfo 
ResolveFileDescriptorBasedMethod "notifyByPspec" o = ObjectNotifyByPspecMethodInfo 
ResolveFileDescriptorBasedMethod "ref" o = ObjectRefMethodInfo 
ResolveFileDescriptorBasedMethod "refSink" o = ObjectRefSinkMethodInfo 
ResolveFileDescriptorBasedMethod "runDispose" o = ObjectRunDisposeMethodInfo 
ResolveFileDescriptorBasedMethod "stealData" o = ObjectStealDataMethodInfo 
ResolveFileDescriptorBasedMethod "stealQdata" o = ObjectStealQdataMethodInfo 
ResolveFileDescriptorBasedMethod "thawNotify" o = ObjectThawNotifyMethodInfo 
ResolveFileDescriptorBasedMethod "unref" o = ObjectUnrefMethodInfo 
ResolveFileDescriptorBasedMethod "watchClosure" o = ObjectWatchClosureMethodInfo 
ResolveFileDescriptorBasedMethod "getData" o = ObjectGetDataMethodInfo 
ResolveFileDescriptorBasedMethod "getFd" o = FileDescriptorBasedGetFdMethodInfo 
ResolveFileDescriptorBasedMethod "getProperty" o = ObjectGetPropertyMethodInfo 
ResolveFileDescriptorBasedMethod "getQdata" o = ObjectGetQdataMethodInfo 
ResolveFileDescriptorBasedMethod "setData" o = ObjectSetDataMethodInfo 
ResolveFileDescriptorBasedMethod "setDataFull" o = ObjectSetDataFullMethodInfo 
ResolveFileDescriptorBasedMethod "setProperty" o = ObjectSetPropertyMethodInfo 
ResolveFileDescriptorBasedMethod l o = MethodResolutionFailed l o :: Type 

getFd

data FileDescriptorBasedGetFdMethodInfo Source #

Instances

Instances details
(signature ~ m Int32, MonadIO m, IsFileDescriptorBased a) => OverloadedMethod FileDescriptorBasedGetFdMethodInfo a signature Source # 
Instance details

Defined in GI.Gio.Interfaces.FileDescriptorBased

Methods

overloadedMethod :: a -> signature #

OverloadedMethodInfo FileDescriptorBasedGetFdMethodInfo (a :: Type) Source # 
Instance details

Defined in GI.Gio.Interfaces.FileDescriptorBased

Methods

overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

fileDescriptorBasedGetFd Source #

Arguments

:: (HasCallStack, MonadIO m, IsFileDescriptorBased a) 
=> a

fdBased: a FileDescriptorBased.

-> m Int32

Returns: The file descriptor

Gets the underlying file descriptor.

Since: 2.24