Efl.Io.File (class)

Description

File access (open, close, read, write, lseek, ftruncate)

Efl.Io.Closer.close_on_exec and Efl.Io.Closer.close_on_destructor are respected and default to true. Efl.Io.Closer.close_on_exec.set sets flag O_CLOEXEC.

Since 1.19

Inheritance

Efl.Loop.Fd (class)Efl.Loop.Consumer (class)Efl.Object (class)

Full hierarchy

Members

close [Overridden from Efl.Io.Closer]

Closes the Input/Output object.
Eina_Error efl_io_closer_close(Eo *obj);


close_on_exec (get, set) [Overridden from Efl.Io.Closer]

If true will automatically close resources on exec() calls.
Eina_Bool efl_io_closer_close_on_exec_get(const Eo *obj);
Eina_Bool efl_io_closer_close_on_exec_set(Eo *obj, Eina_Bool close_on_exec);


constructor [Overridden from Efl.Object]

Call the object's constructor.
Efl_Object *efl_constructor(Eo *obj);


destructor [Overridden from Efl.Object]

Call the object's destructor.
void efl_destructor(Eo *obj);


fd_file (get, set) [Overridden from Efl.Loop.Fd]

Defines which file descriptor to watch when watching a file.
int efl_loop_fd_file_get(const Eo *obj);
void efl_loop_fd_file_set(Eo *obj, int fd);


file (get, set) [Overridden from Efl.File]

void efl_file_get(const Eo *obj, const char **file, const char **key);
Eina_Bool efl_file_set(Eo *obj, const char *file, const char *key);


finalize [Overridden from Efl.Object]

Called at the end of efl_add. Should not be called, just overridden.
Efl_Object *efl_finalize(Eo *obj);


flags (get, set)

Bitwise OR'ed flags to open the file, like O_CREAT, O_APPEND...
uint32_t efl_io_file_flags_get(const Eo *obj);
void efl_io_file_flags_set(Eo *obj, uint32_t flags);


mode (get, set)

Mode property
uint32_t efl_io_file_mode_get(const Eo *obj);
void efl_io_file_mode_set(Eo *obj, uint32_t mode);


read [Overridden from Efl.Io.Reader]

Reads data into a pre-allocated buffer.
Eina_Error efl_io_reader_read(Eo *obj, Eina_Rw_Slice rw_slice);


resize [Overridden from Efl.Io.Sizer]

Resize object
Eina_Error efl_io_sizer_resize(Eo *obj, uint64_t size);


seek [Overridden from Efl.Io.Positioner]

Seek in data
Eina_Error efl_io_positioner_seek(Eo *obj, int64_t offset, Efl_Io_Positioner_Whence whence);


write [Overridden from Efl.Io.Writer]

Writes data from a pre-populated buffer.
Eina_Error efl_io_writer_write(Eo *obj, Eina_Slice slice, Eina_Slice *remaining);


Inherited

Efl.File
load_error (get) Gets the (last) file loading error for a given object.
mmap (get, set)
save Save the given image object's contents to an (image) file.
Efl.Io.Closer.Fd
close_on_destructor (get, set) If true will automatically close() on object destructor.
closed (get, set) If true will notify object was closed.
protected set closer_fd (get, set) Closer file descriptor
Efl.Io.Positioner.Fd
position (get, set) Position property
protected set positioner_fd (get, set) Positionier file descriptor
Efl.Io.Reader.Fd
protected set can_read (get, set) If true will notify Efl.Io.Reader.read can be called without blocking or failing.
protected set eos (get, set) If true will notify end of stream.
protected set reader_fd (get, set) Reader file descriptor
Efl.Io.Sizer.Fd
size (get, set) Size property
protected set sizer_fd (get, set) Sizer file descriptor
Efl.Io.Writer.Fd
protected set can_write (get, set) If true will notify Efl.Io.Writer.write can be called without blocking or failing.
protected set writer_fd (get, set) Writer file descriptor
Efl.Loop.Consumer
loop (get) The loop to which this object belongs to.
Efl.Loop.Fd
fd (get, set) Defines which file descriptor to watch. If it is a file, use file_fd variant.
parent (get, set) The parent of an object.
Efl.Object
allow_parent_unref (get, set) Allow an object to be deleted by unref even if it has a parent.
children_iterator_new Get an iterator on all childrens
comment (get, set) A human readable comment for the object
composite_attach Make an object a composite object of another.
composite_detach Detach a composite object from another object.
composite_part_is Check if an object is part of a composite object.
debug_name_override Build a read-only name for this object used for debugging.
del Unrefs the object and reparents it to NULL.
event_callback_forwarder_add Add an event callback forwarder for an event and an object.
event_callback_forwarder_del Remove an event callback forwarder for an event and an object.
event_callback_stop Stop the current callback call.
event_freeze Freeze events of object.
event_freeze_count (get) Return freeze events of object.
class event_global_freeze Freeze events of object.
class event_global_freeze_count (get) Return freeze events of object.
class event_global_thaw Thaw events of object.
event_thaw Thaw events of object.
finalized (get) True if the object is already finalized, otherwise false.
name (get, set) The name of the object.
name_find Find a child object with the given name and return it.
provider_find Searches upwards in the object tree for a provider which knows the given class/interface.

Events

Inherited

Efl.Io.Closer
closed Notifies closed, when property is marked as true
Efl.Io.Positioner
position,changed Notifies position changed
Efl.Io.Reader
can_read,changed Notifies can_read property changed.
eos Notifies end of stream, when property is marked as true.
Efl.Io.Sizer
size,changed Notifies size changed
Efl.Io.Writer
can_write,changed Notifies can_write property changed.
Efl.Loop.Fd
error Called when a error occurred on the file descriptor
read Called when a read happened on the file descriptor
write Called when a write happened on the file descriptor
Efl.Object
callback,add A callback was added.
callback,del A callback was deleted.
del Object is being deleted.
destruct Object has been fully destroyed. It can not be used beyond this point. This event should only serve to clean up any dangling pointer.