GI.Gio.Objects.FileIOStream

GFileIOStream provides io streams that both read and write to the same file handle.

GFileIOStream implements Seekable, which allows the io stream to jump to arbitrary positions in the file and to truncate the file, provided the filesystem of the file supports these operations.

To find the position of a file io stream, use seekableTell.

To find out if a file io stream supports seeking, use seekableCanSeek. To position a file io stream, use seekableSeek. To find out if a file io stream supports truncating, use seekableCanTruncate. To truncate a file io stream, use seekableTruncate.

The default implementation of all the FileIOStream operations and the implementation of Seekable just call into the same operations on the output stream.

Exported types

newtype FileIOStream

Constructors

FileIOStream (ManagedPtr FileIOStream)

Instances

GObject FileIOStream

Methods

gobjectType :: FileIOStream -> IO GType

IsObject FileIOStream

IsIOStream FileIOStream

IsFileIOStream FileIOStream

IsSeekable FileIOStream

((~) * info (ResolveFileIOStreamMethod t FileIOStream), MethodInfo * info FileIOStream p) => IsLabel t (FileIOStream -> p)

Methods

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

((~) * info (ResolveFileIOStreamMethod t FileIOStream), MethodInfo * info FileIOStream p) => IsLabelProxy t (FileIOStream -> p)

Methods

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

HasAttributeList * FileIOStream

type AttributeList FileIOStream

type AttributeList FileIOStream

type SignalList FileIOStream

type SignalList FileIOStream

class GObject o => IsFileIOStream o

Instances

(GObject a, UnknownAncestorError Constraint FileIOStream a) => IsFileIOStream a

IsFileIOStream FileIOStream

toFileIOStream :: IsFileIOStream o => o -> IO FileIOStream

noFileIOStream :: Maybe FileIOStream

Methods

getEtag

data FileIOStreamGetEtagMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsFileIOStream a) => MethodInfo * FileIOStreamGetEtagMethodInfo a signature

Methods

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

fileIOStreamGetEtag

Arguments

:: (HasCallStack, MonadIO m, IsFileIOStream a)

=> a

stream: a FileIOStream.

-> m Text

Returns: the entity tag for the stream.

Gets the entity tag for the file when it has been written. This must be called after the stream has been written and closed, as the etag can change while writing.

Since: 2.22

queryInfo

data FileIOStreamQueryInfoMethodInfo

Instances

((~) * signature (Text -> Maybe b -> m FileInfo), MonadIO m, IsFileIOStream a, IsCancellable b) => MethodInfo * FileIOStreamQueryInfoMethodInfo a signature

Methods

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

fileIOStreamQueryInfo

Arguments

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

=> a

stream: a FileIOStream.

-> Text

attributes: a file attribute query string.

-> Maybe b

cancellable: optional Cancellable object, Nothing to ignore.

-> m FileInfo

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

Queries a file io stream for the given attributes. This function blocks while querying the stream. For the asynchronous version of this function, see fileIOStreamQueryInfoAsync. While the stream is blocked, the stream will set the pending flag internally, and any other operations on the stream will fail with IOErrorEnumPending.

Can fail if the stream was already closed (with error being set to IOErrorEnumClosed), the stream has pending operations (with error being set to IOErrorEnumPending), or if querying info is not supported for the stream's interface (with error being set to IOErrorEnumNotSupported). I all cases of failure, Nothing will be returned.

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, and Nothing will be returned.

Since: 2.22

queryInfoAsync

data FileIOStreamQueryInfoAsyncMethodInfo

Instances

((~) * signature (Text -> Int32 -> Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsFileIOStream a, IsCancellable b) => MethodInfo * FileIOStreamQueryInfoAsyncMethodInfo a signature

Methods

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

fileIOStreamQueryInfoAsync

Arguments

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

=> a

stream: a FileIOStream.

-> Text

attributes: a file attribute query string.

-> Int32

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

-> Maybe b

cancellable: optional Cancellable object, Nothing to ignore.

-> Maybe AsyncReadyCallback

callback: callback to call when the request is satisfied

-> m ()

Asynchronously queries the stream for a FileInfo. When completed, callback will be called with a AsyncResult which can be used to finish the operation with fileIOStreamQueryInfoFinish.

For the synchronous version of this function, see fileIOStreamQueryInfo.

Since: 2.22

queryInfoFinish

data FileIOStreamQueryInfoFinishMethodInfo

Instances

((~) * signature (b -> m FileInfo), MonadIO m, IsFileIOStream a, IsAsyncResult b) => MethodInfo * FileIOStreamQueryInfoFinishMethodInfo a signature

Methods

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

fileIOStreamQueryInfoFinish

Arguments

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

=> a

stream: a FileIOStream.

-> b

result: a AsyncResult.

-> m FileInfo

Returns: A FileInfo for the finished query. (Can throw GError)

Finalizes the asynchronous query started by fileIOStreamQueryInfoAsync.

Since: 2.22