Class FileIOStream

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.IOStream

org.gnome.gio.FileIOStream

All Implemented Interfaces:

AutoCloseable, Seekable, Proxy, AutoCloseable

@Generated("org.javagi.JavaGI")
public class FileIOStream
extends IOStream
implements Seekable

GFileIOStream provides I/O streams that both read and write to the same file handle.

GFileIOStream implements Seekable, which allows the I/O 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 I/O stream, use Seekable.tell().

To find out if a file I/O stream supports seeking, use Seekable.canSeek(). To position a file I/O stream, use Seekable.seek(long, SeekType, Cancellable). To find out if a file I/O stream supports truncating, use Seekable.canTruncate(). To truncate a file I/O stream, use Seekable.truncate(long, Cancellable).

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

Since:

2.22

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileIOStream.Builder<B extends FileIOStream.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	FileIOStream.FileIOStreamClass

Nested classes/interfaces inherited from class IOStream

IOStream.IOStream$Impl, IOStream.IOStreamClass

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface Seekable

Seekable.Seekable$Impl, Seekable.SeekableIface

Constructor Summary

Constructors

Constructor	Description
FileIOStream()	Create a new FileIOStream.
FileIOStream(MemorySegment address)	Create a FileIOStream instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected FileIOStream	asParent()	Return this instance as if it were its parent type.
static FileIOStream.Builder<? extends FileIOStream.Builder>	builder()	A FileIOStream.Builder object constructs a FileIOStream with the specified properties.
@Nullable String	getEtag()	Gets the entity tag for the file when it has been written.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the FileIOStream class.
FileInfo	queryInfo(String attributes, @Nullable Cancellable cancellable)	Queries a file io stream for the given attributes. This function blocks while querying the stream.
void	queryInfoAsync(String attributes, int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously queries the this FileIOStream for a GFileInfo.
FileInfo	queryInfoFinish(AsyncResult result)	Finalizes the asynchronous query started by g_file_io_stream_query_info_async().
protected boolean	truncateFn(long size, @Nullable Cancellable cancellable)

Methods inherited from class IOStream

clearPending, close, closeAsync, closeFinish, closeFn, getInputStream, getOutputStream, hasPending, isClosed, setPending, spliceAsync, spliceAsync, spliceFinish

Methods inherited from class GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface AutoCloseable

close

Methods inherited from interface Proxy

handle

Methods inherited from interface Seekable

canSeek, canTruncate, seek, tell, truncate

Constructor Details

FileIOStream

public FileIOStream(MemorySegment address)

Create a FileIOStream instance for the provided memory address.

Parameters:

address - the memory address of the native object

FileIOStream

public FileIOStream()

Create a new FileIOStream.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the FileIOStream class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected FileIOStream asParent()

Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.

Overrides:

asParent in class IOStream

Returns:

the instance as if it were its parent type

getEtag

public @Nullable String getEtag()

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.

Returns:

the entity tag for the stream.

Since:

2.22

queryInfo

public FileInfo queryInfo(String attributes,
 @Nullable Cancellable cancellable)
                   throws GErrorException

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

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

If cancellable is not null, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error IOErrorEnum.CANCELLED will be set, and null will be returned.

Parameters:

attributes - a file attribute query string.

cancellable - optional GCancellable object, null to ignore.

Returns:

a GFileInfo for the stream, or null on error.

Throws:

GErrorException - see GError

Since:

2.22

queryInfoAsync

public void queryInfoAsync(String attributes,
 int ioPriority,
 @Nullable Cancellable cancellable,
 @Nullable AsyncReadyCallback callback)

Asynchronously queries the this FileIOStream for a GFileInfo. When completed, callback will be called with a GAsyncResult which can be used to finish the operation with g_file_io_stream_query_info_finish().

For the synchronous version of this function, see g_file_io_stream_query_info().

Parameters:

attributes - a file attribute query string.

ioPriority - the I/O priority of the request

cancellable - optional GCancellable object, null to ignore.

callback - a GAsyncReadyCallback to call when the request is satisfied

Since:

2.22

queryInfoFinish

public FileInfo queryInfoFinish(AsyncResult result)
                         throws GErrorException

Finalizes the asynchronous query started by g_file_io_stream_query_info_async().

Parameters:

result - a GAsyncResult.

Returns:

A GFileInfo for the finished query.

Throws:

GErrorException - see GError

Since:

2.22

truncateFn

protected boolean truncateFn(long size,
 @Nullable Cancellable cancellable)
                      throws GErrorException

Throws:

GErrorException

builder

public static FileIOStream.Builder<? extends FileIOStream.Builder> builder()

A FileIOStream.Builder object constructs a FileIOStream with the specified properties. Use the various set...() methods to set properties, and finish construction with FileIOStream.Builder.build().

Returns:

the builder object