efl/src/lib/eio/efl_io_manager.eo

118 lines
3.6 KiB
Plaintext

import eina_types;
struct @beta Eio.Data
{
[[A structure to handle arbitrary data to be sent over Promises.]]
data: void_ptr; [[Private data pointer]]
size: uint; [[Size of private data]]
}
function @beta EflIoPath {
[[EflIoPath function]]
params {
@in paths: array<string>; [[Accessor to an array of path.]]
}
};
function @beta EflIoDirectInfo {
[[EflIoDirectInfo function]]
params {
@in entries: array<Eina.File_Direct_Info>; [[Accessor to an array of info.]]
}
};
class @beta Efl.Io.Manager extends Efl.Loop_Consumer
{
[[Class representing an asynchronous file operation.]]
methods {
ls @const {
[[Lists entries in a given path.
See @Eina.File.
]]
params {
@in path: string; [[Path we want to list entries for]]
paths: EflIoPath; [[Callback called for each packet of files found]]
}
return: future<uint64> @move; [[Amount of files found during the listing of the directory]]
}
direct_ls @const {
[[Lists entries in a given path with more information.]]
params {
@in path: string;[[Path we want to list entries for]]
@in recursive: bool; [[If $true, list entries recursively, $false otherwise]]
info: EflIoDirectInfo; [[Callback called for each packet of @Eina.File_Direct_Info]]
}
return: future<uint64> @move; [[Amount of files found during the listing of the directory]]
}
stat_ls @const {
[[Lists entries in a given path with stat information.]]
params {
@in path: string;[[Path we want to list entries for]]
@in recursive: bool; [[If $true, list entries recursively, $false otherwise]]
info: EflIoDirectInfo; [[Callback called for each packet of @Eina.File_Direct_Info]]
}
return: future<uint64> @move; [[Amount of files found during the listing of the directory]]
}
// Extended attributes
xattr_ls @const {
[[Lists all extended attributes asynchronously.]]
params {
@in path: string; [[Path we want to list entries for]]
paths: EflIoPath; [[Callback called for each packet of extended attributes found.]]
}
return: future<uint64> @move; [[Amount of extended attributes found]]
}
stat @const {
[[Get stat info on a given file/directory.]]
params {
@in path: string; [[Path we want to get stat information for]]
}
return: future<Eina.Stat>; [[Stat information]]
}
// FIXME: Add helper for Eina.Value to Xattr
@property xattr {
[[Retrieves or sets information of a given extended attribute.]]
set {
values {
data: ptr(Eina.Binbuf); [[Data to set as information]]
flags: Eina.Xattr.Flags; [[Extended attributes flags]]
}
return: future<uint64> @move; [[Future for asynchronous set operation]]
}
get {
return: future<Eina.Binbuf> @move; [[Information]]
}
keys {
path: string; [[File path]]
attribute: string; [[Attribute name]]
}
}
// helper api
open @const {
[[Opens a file.
The fulfilled value in the promise will be the Eina.File*.]]
params {
@in path: string; [[Path to file]]
@in shared: bool; [[$true if the file can be accessed by others, $false otherwise]]
}
return: future<Eina.File> @move; [[Eina file handle]]
}
close @const {
[[Closes an open Eina.File.]]
params {
@in file: ptr(Eina.File); [[Eina file handle]]
// Here we're just interested whether the promise was fulfilled or not. No value needed.
}
return: future<int> @move; [[Close return code]]
}
}
}