FileInfo

Functionality for manipulating basic metadata for files. gio.FileInfo implements methods for getting information that all files should contain, and allows for manipulation of extended attributes.

See GFileAttribute[gio-GFileAttribute] for more information on how GIO handles file attributes.

To obtain a gio.FileInfo for a GFile, use g_file_query_info() (or its async variant). To obtain a gio.FileInfo for a file input or output stream, use FileInputStream.queryInfo or FileOutputStream.queryInfo (or their async variants).

To change the actual attributes of a file, you should then set the attribute in the gio.FileInfo and call g_file_set_attributes_from_info() or g_file_set_attributes_async() on a GFile.

However, not all attributes can be changed in the file. For instance, the actual size of a file cannot be changed via FileInfo.setSize. You may call g_file_query_settable_attributes() and g_file_query_writable_namespaces() to discover the settable attributes of a particular file at runtime.

gio.FileAttributeMatcher allows for searching through a gio.FileInfo for attributes.

class FileInfo : ObjectG {

GFileInfo* gFileInfo;

GFileInfo* getFileInfoStruct(bool transferOwnership);

void* getStruct();

this(GFileInfo* gFileInfo, bool ownedRef);

static GType getType();

void clearStatus();

void copyInto(FileInfo destInfo);

FileInfo dup();

string getAttributeAsString(string attribute);

bool getAttributeBoolean(string attribute);

string getAttributeByteString(string attribute);

bool getAttributeData(string attribute, GFileAttributeType type, void* valuePp, GFileAttributeStatus status);

int getAttributeInt32(string attribute);

long getAttributeInt64(string attribute);

ObjectG getAttributeObject(string attribute);

GFileAttributeStatus getAttributeStatus(string attribute);

string getAttributeString(string attribute);

string[] getAttributeStringv(string attribute);

GFileAttributeType getAttributeType(string attribute);

uint getAttributeUint32(string attribute);

ulong getAttributeUint64(string attribute);

string getContentType();

DateTime getDeletionDate();

string getDisplayName();

string getEditName();

string getEtag();

GFileType getFileType();

IconIF getIcon();

bool getIsBackup();

bool getIsHidden();

bool getIsSymlink();

DateTime getModificationDateTime();

void getModificationTime(TimeVal result);

string getName();

long getSize();

int getSortOrder();

IconIF getSymbolicIcon();

string getSymlinkTarget();

bool hasAttribute(string attribute);

bool hasNamespace(string nameSpace);

string[] listAttributes(string nameSpace);

void removeAttribute(string attribute);

void setAttribute(string attribute, GFileAttributeType type, void* valueP);

void setAttributeBoolean(string attribute, bool attrValue);

void setAttributeByteString(string attribute, string attrValue);

void setAttributeInt32(string attribute, int attrValue);

void setAttributeInt64(string attribute, long attrValue);

void setAttributeMask(FileAttributeMatcher mask);

void setAttributeObject(string attribute, ObjectG attrValue);

bool setAttributeStatus(string attribute, GFileAttributeStatus status);

void setAttributeString(string attribute, string attrValue);

void setAttributeStringv(string attribute, string[] attrValue);

void setAttributeUint32(string attribute, uint attrValue);

void setAttributeUint64(string attribute, ulong attrValue);

void setContentType(string contentType);

void setDisplayName(string displayName);

void setEditName(string editName);

void setFileType(GFileType type);

void setIcon(IconIF icon);

void setIsHidden(bool isHidden);

void setIsSymlink(bool isSymlink);

void setModificationDateTime(DateTime mtime);

void setModificationTime(TimeVal mtime);

void setName(string name);

void setSize(long size);

void setSortOrder(int sortOrder);

void setSymbolicIcon(IconIF icon);

void setSymlinkTarget(string symlinkTarget);

void unsetAttributeMask();

}

Constructors

this this(GFileInfo* gFileInfo, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Creates a new file info structure.

Members

Functions

clearStatus void clearStatus(): Clears the status information from info.
copyInto void copyInto(FileInfo destInfo): First clears all of the GFileAttribute[gio-GFileAttribute] of dest_info, and then copies all of the file attributes from src_info to dest_info.
dup FileInfo dup(): Duplicates a file info structure.
getAttributeAsString string getAttributeAsString(string attribute): Gets the value of a attribute, formated as a string. This escapes things as needed to make the string valid UTF-8.
getAttributeBoolean bool getAttributeBoolean(string attribute): Gets the value of a boolean attribute. If the attribute does not contain a boolean value, FALSE will be returned.
getAttributeByteString string getAttributeByteString(string attribute): Gets the value of a byte string attribute. If the attribute does not contain a byte string, NULL will be returned.
getAttributeData bool getAttributeData(string attribute, GFileAttributeType type, void* valuePp, GFileAttributeStatus status): Gets the attribute type, value and status for an attribute key.
getAttributeInt32 int getAttributeInt32(string attribute): Gets a signed 32-bit integer contained within the attribute. If the attribute does not contain a signed 32-bit integer, or is invalid, 0 will be returned.
getAttributeInt64 long getAttributeInt64(string attribute): Gets a signed 64-bit integer contained within the attribute. If the attribute does not contain a signed 64-bit integer, or is invalid, 0 will be returned.
getAttributeObject ObjectG getAttributeObject(string attribute): Gets the value of a GObject attribute. If the attribute does not contain a GObject, NULL will be returned.
getAttributeStatus GFileAttributeStatus getAttributeStatus(string attribute): Gets the attribute status for an attribute key.
getAttributeString string getAttributeString(string attribute): Gets the value of a string attribute. If the attribute does not contain a string, NULL will be returned.
getAttributeStringv string[] getAttributeStringv(string attribute): Gets the value of a stringv attribute. If the attribute does not contain a stringv, NULL will be returned.
getAttributeType GFileAttributeType getAttributeType(string attribute): Gets the attribute type for an attribute key.
getAttributeUint32 uint getAttributeUint32(string attribute): Gets an unsigned 32-bit integer contained within the attribute. If the attribute does not contain an unsigned 32-bit integer, or is invalid, 0 will be returned.
getAttributeUint64 ulong getAttributeUint64(string attribute): Gets a unsigned 64-bit integer contained within the attribute. If the attribute does not contain an unsigned 64-bit integer, or is invalid, 0 will be returned.
getContentType string getContentType(): Gets the file's content type.
getDeletionDate DateTime getDeletionDate(): Returns the gstreamer.DateTime representing the deletion date of the file, as available in G_FILE_ATTRIBUTE_TRASH_DELETION_DATE. If the G_FILE_ATTRIBUTE_TRASH_DELETION_DATE attribute is unset, NULL is returned.
getDisplayName string getDisplayName(): Gets a display name for a file.
getEditName string getEditName(): Gets the edit name for a file.
getEtag string getEtag(): Gets the [entity tag][gfile-etag] for a given gio.FileInfo See G_FILE_ATTRIBUTE_ETAG_VALUE.
getFileInfoStruct GFileInfo* getFileInfoStruct(bool transferOwnership): Get the main Gtk struct
getFileType GFileType getFileType(): Gets a file's type (whether it is a regular file, symlink, etc). This is different from the file's content type, see FileInfo.getContentType.
getIcon IconIF getIcon(): Gets the icon for a file.
getIsBackup bool getIsBackup(): Checks if a file is a backup file.
getIsHidden bool getIsHidden(): Checks if a file is hidden.
getIsSymlink bool getIsSymlink(): Checks if a file is a symlink.
getModificationDateTime DateTime getModificationDateTime(): Gets the modification time of the current info and returns it as a gstreamer.DateTime
getModificationTime void getModificationTime(TimeVal result): Gets the modification time of the current info and sets it in result.
getName string getName(): Gets the name for a file.
getSize long getSize(): Gets the file's size.
getSortOrder int getSortOrder(): Gets the value of the sort_order attribute from the gio.FileInfo See G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER.
getStruct void* getStruct(): the main Gtk struct as a void*
getSymbolicIcon IconIF getSymbolicIcon(): Gets the symbolic icon for a file.
getSymlinkTarget string getSymlinkTarget(): Gets the symlink target for a given gio.FileInfo
hasAttribute bool hasAttribute(string attribute): Checks if a file info structure has an attribute named attribute.
hasNamespace bool hasNamespace(string nameSpace): Checks if a file info structure has an attribute in the specified name_space.
listAttributes string[] listAttributes(string nameSpace): Lists the file info structure's attributes.
removeAttribute void removeAttribute(string attribute): Removes all cases of attribute from info if it exists.
setAttribute void setAttribute(string attribute, GFileAttributeType type, void* valueP): Sets the attribute to contain the given value, if possible. To unset the attribute, use G_FILE_ATTRIBUTE_TYPE_INVALID for type.
setAttributeBoolean void setAttributeBoolean(string attribute, bool attrValue): Sets the attribute to contain the given attr_value, if possible.
setAttributeByteString void setAttributeByteString(string attribute, string attrValue): Sets the attribute to contain the given attr_value, if possible.
setAttributeInt32 void setAttributeInt32(string attribute, int attrValue): Sets the attribute to contain the given attr_value, if possible.
setAttributeInt64 void setAttributeInt64(string attribute, long attrValue): Sets the attribute to contain the given attr_value, if possible.
setAttributeMask void setAttributeMask(FileAttributeMatcher mask): Sets mask on info to match specific attribute types.
setAttributeObject void setAttributeObject(string attribute, ObjectG attrValue): Sets the attribute to contain the given attr_value, if possible.
setAttributeStatus bool setAttributeStatus(string attribute, GFileAttributeStatus status): Sets the attribute status for an attribute key. This is only needed by external code that implement g_file_set_attributes_from_info() or similar functions.
setAttributeString void setAttributeString(string attribute, string attrValue): Sets the attribute to contain the given attr_value, if possible.
setAttributeStringv void setAttributeStringv(string attribute, string[] attrValue): Sets the attribute to contain the given attr_value, if possible.
setAttributeUint32 void setAttributeUint32(string attribute, uint attrValue): Sets the attribute to contain the given attr_value, if possible.
setAttributeUint64 void setAttributeUint64(string attribute, ulong attrValue): Sets the attribute to contain the given attr_value, if possible.
setContentType void setContentType(string contentType): Sets the content type attribute for a given gio.FileInfo See G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE.
setDisplayName void setDisplayName(string displayName): Sets the display name for the current gio.FileInfo See G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME.
setEditName void setEditName(string editName): Sets the edit name for the current file. See G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME.
setFileType void setFileType(GFileType type): Sets the file type in a gio.FileInfo to type. See G_FILE_ATTRIBUTE_STANDARD_TYPE.
setIcon void setIcon(IconIF icon): Sets the icon for a given gio.FileInfo See G_FILE_ATTRIBUTE_STANDARD_ICON.
setIsHidden void setIsHidden(bool isHidden): Sets the "is_hidden" attribute in a gio.FileInfo according to is_hidden. See G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN.
setIsSymlink void setIsSymlink(bool isSymlink): Sets the "is_symlink" attribute in a gio.FileInfo according to is_symlink. See G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK.
setModificationDateTime void setModificationDateTime(DateTime mtime): Sets the G_FILE_ATTRIBUTE_TIME_MODIFIED and G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC attributes in the file info to the given date/time value.
setModificationTime void setModificationTime(TimeVal mtime): Sets the G_FILE_ATTRIBUTE_TIME_MODIFIED and G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC attributes in the file info to the given time value.
setName void setName(string name): Sets the name attribute for the current gio.FileInfo See G_FILE_ATTRIBUTE_STANDARD_NAME.
setSize void setSize(long size): Sets the G_FILE_ATTRIBUTE_STANDARD_SIZE attribute in the file info to the given size.
setSortOrder void setSortOrder(int sortOrder): Sets the sort order attribute in the file info structure. See G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER.
setSymbolicIcon void setSymbolicIcon(IconIF icon): Sets the symbolic icon for a given gio.FileInfo See G_FILE_ATTRIBUTE_STANDARD_SYMBOLIC_ICON.
setSymlinkTarget void setSymlinkTarget(string symlinkTarget): Sets the G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET attribute in the file info to the given symlink target.
unsetAttributeMask void unsetAttributeMask(): Unsets a mask set by FileInfo.setAttributeMask, if one is set.

Static functions

getType GType getType()

Variables

gFileInfo GFileInfo* gFileInfo;: the main Gtk struct

Inherited Members

From ObjectG

gObject GObject* gObject;: the main Gtk struct
getObjectGStruct GObject* getObjectGStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
opCast T opCast()
getDObject RT getDObject(U obj, bool ownedRef): Gets a D Object from the objects table of associations.
setProperty void setProperty(string propertyName, T value)
addOnNotify gulong addOnNotify(void delegate(ParamSpec, ObjectG) dlg, string property, ConnectFlags connectFlags): The notify signal is emitted on an object when one of its properties has been changed. Note that getting this signal doesn't guarantee that the value of the property has actually changed, it may also be emitted when the setter for the property is called to reinstate the previous value.
getType GType getType()
compatControl size_t compatControl(size_t what, void* data)
interfaceFindProperty ParamSpec interfaceFindProperty(TypeInterface gIface, string propertyName): Find the gobject.ParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().
interfaceInstallProperty void interfaceInstallProperty(TypeInterface gIface, ParamSpec pspec): Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created gobject.ParamSpec, but normally ObjectClass.overrideProperty will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
interfaceListProperties ParamSpec[] interfaceListProperties(TypeInterface gIface): Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().
addToggleRef void addToggleRef(GToggleNotify notify, void* data): Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established.
addWeakPointer void addWeakPointer(void* weakPointerLocation): Adds a weak reference from weak_pointer to object to indicate that the pointer located at weak_pointer_location is only valid during the lifetime of object. When the object is finalized, weak_pointer will be set to NULL.
bindProperty Binding bindProperty(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags): Creates a binding between source_property on source and target_property on target. Whenever the source_property is changed the target_property is updated using the same value. For instance:
bindPropertyFull Binding bindPropertyFull(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, GBindingTransformFunc transformTo, GBindingTransformFunc transformFrom, void* userData, GDestroyNotify notify): Complete version of g_object_bind_property().
bindPropertyWithClosures Binding bindPropertyWithClosures(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, Closure transformTo, Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
dupData void* dupData(string key, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_data() which returns a 'duplicate' of the value. dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
dupQdata void* dupQdata(GQuark quark, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
forceFloating void forceFloating(): This function is intended for GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see g_object_set_data()).
getProperty void getProperty(string propertyName, Value value): Gets a property of an object.
getQdata void* getQdata(GQuark quark): This function gets back user data pointers stored via g_object_set_qdata().
getValist void getValist(string firstPropertyName, void* varArgs): Gets properties of an object.
getv void getv(string[] names, Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
ref_ ObjectG ref_(): Increases the reference count of object.
refSink ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
removeToggleRef void removeToggleRef(GToggleNotify notify, void* data): Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one.
removeWeakPointer void removeWeakPointer(void* weakPointerLocation): Removes a weak reference from object that was previously added using g_object_add_weak_pointer(). The weak_pointer_location has to match the one used with g_object_add_weak_pointer().
replaceData bool replaceData(string key, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key key on object with oldval, and if they are the same, replaces oldval with newval.
replaceQdata bool replaceQdata(GQuark quark, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key quark on object with oldval, and if they are the same, replaces oldval with newval.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setDataFull void setDataFull(string key, void* data, GDestroyNotify destroy): Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed.
setProperty void setProperty(string propertyName, Value value): Sets a property on an object.
setQdata void setQdata(GQuark quark, void* data): This sets an opaque, named pointer on an object. The name is specified through a GQuark (retrived e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the object with g_object_get_qdata() until the object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using NULL as pointer essentially removes the data stored.
setQdataFull void setQdataFull(GQuark quark, void* data, GDestroyNotify destroy): This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with data as argument when the object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same quark.
setValist void setValist(string firstPropertyName, void* varArgs): Sets properties on an object.
setv void setv(string[] names, Value[] values): Sets n_properties properties for an object. Properties to be set will be taken from values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(GQuark quark): This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
unref void unref(): Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).
watchClosure void watchClosure(Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
weakRef void weakRef(GWeakNotify notify, void* data): Adds a weak reference callback to an object. Weak references are used for notification when an object is finalized. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).
weakUnref void weakUnref(GWeakNotify notify, void* data): Removes a weak reference callback to an object.
clearObject void clearObject(ObjectG objectPtr): Clears a reference to a GObject

gio FileInfo classes

FileInfo