GI.Gio.Objects.FileInputStream

GFileInputStream provides input streams that take their content from a file.

GFileInputStream implements Seekable, which allows the input stream to jump to arbitrary positions in the file, provided the filesystem of the file allows it. To find the position of a file input stream, use seekableTell. To find out if a file input stream supports seeking, use seekableCanSeek. To position a file input stream, use seekableSeek.

Exported types

newtype FileInputStream

Memory-managed wrapper type.

Constructors

FileInputStream (ManagedPtr FileInputStream)

Instances

Eq FileInputStream

Defined in GI.Gio.Objects.FileInputStream

Methods

(==) :: FileInputStream -> FileInputStream -> Bool

(/=) :: FileInputStream -> FileInputStream -> Bool

GObject FileInputStream

Defined in GI.Gio.Objects.FileInputStream

ManagedPtrNewtype FileInputStream

Defined in GI.Gio.Objects.FileInputStream

Methods

toManagedPtr :: FileInputStream -> ManagedPtr FileInputStream

TypedObject FileInputStream

Defined in GI.Gio.Objects.FileInputStream

Methods

glibType :: IO GType

HasParentTypes FileInputStream

Defined in GI.Gio.Objects.FileInputStream

IsGValue (Maybe FileInputStream)

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

Defined in GI.Gio.Objects.FileInputStream

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe FileInputStream -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe FileInputStream)

type ParentTypes FileInputStream

Defined in GI.Gio.Objects.FileInputStream

type ParentTypes FileInputStream = '[InputStream, Object, Seekable]

class (GObject o, IsDescendantOf FileInputStream o) => IsFileInputStream o

Type class for types which can be safely cast to FileInputStream, for instance with toFileInputStream.

Instances

(GObject o, IsDescendantOf FileInputStream o) => IsFileInputStream o

Defined in GI.Gio.Objects.FileInputStream

toFileInputStream :: (MonadIO m, IsFileInputStream o) => o -> m FileInputStream

Cast to FileInputStream, 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

Methods

bindProperty, bindPropertyFull, canSeek, canTruncate, clearPending, close, closeAsync, closeFinish, forceFloating, freezeNotify, getv, hasPending, isClosed, isFloating, notify, notifyByPspec, queryInfo, queryInfoAsync, queryInfoFinish, read, readAll, readAllAsync, readAllFinish, readAsync, readBytes, readBytesAsync, readBytesFinish, readFinish, ref, refSink, runDispose, seek, skip, skipAsync, skipFinish, stealData, stealQdata, tell, thawNotify, truncate, unref, watchClosure.

Getters

getData, getProperty, getQdata.

Setters

setData, setDataFull, setPending, setProperty.

queryInfo

fileInputStreamQueryInfo

Arguments

:: (HasCallStack, MonadIO m, IsFileInputStream a, IsCancellable b)

=> a

stream: a FileInputStream.

-> Text

attributes: a file attribute query string.

-> Maybe b

cancellable: optional Cancellable object, Nothing to ignore.

-> m FileInfo

Returns: a FileInfo, or Nothing on error. (Can throw GError)

Queries a file input stream the given attributes. This function blocks while querying the stream. For the asynchronous (non-blocking) version of this function, see fileInputStreamQueryInfoAsync. While the stream is blocked, the stream will set the pending flag internally, and any other operations on the stream will fail with IOErrorEnumPending.

queryInfoAsync

fileInputStreamQueryInfoAsync

Arguments

:: (HasCallStack, MonadIO m, IsFileInputStream a, IsCancellable b)

=> a

stream: a FileInputStream.

-> Text

attributes: a file attribute query string.

-> Int32

ioPriority: the [I/O priority][io-priority] of the request

-> Maybe b

cancellable: optional Cancellable object, Nothing to ignore.

-> Maybe AsyncReadyCallback

callback: callback to call when the request is satisfied

-> m ()

Queries the stream information asynchronously. When the operation is finished callback will be called. You can then call fileInputStreamQueryInfoFinish to get the result of the operation.

For the synchronous version of this function, see fileInputStreamQueryInfo.

If cancellable is not Nothing, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error IOErrorEnumCancelled will be set

queryInfoFinish

fileInputStreamQueryInfoFinish

Arguments

:: (HasCallStack, MonadIO m, IsFileInputStream a, IsAsyncResult b)

=> a

stream: a FileInputStream.

-> b

result: a AsyncResult.

-> m FileInfo

Returns: FileInfo. (Can throw GError)

Finishes an asynchronous info query operation.