summaryrefslogtreecommitdiff
path: root/src/lib/eio/efl_io_manager.eo
blob: 9d8f46d5897885ca3795f5c766a1bcc268d36132 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
import eina_types;

struct 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]]
}

class Efl.Io.Manager (Efl.Loop_User)
{
  [[Class representing an asynchronous file operation.]]

  methods {
    ls {
      [[Lists entries in a given path.]]
      params {
        @in path: string; [[Path we want to list entries for]]
      }
      return: future<uint64, const(array<string>)>; [[List of entries in path]]
    }

    direct_ls {
      [[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]]
      }
      return: future<uint64, const(array<Eina.File.Direct.Info>)>; [[List of entries in path]]
    }

    stat_ls {
      [[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]]
      }
      return: future<uint64, const(array<Eina.File.Direct.Info>)>; [[List of entries in path]]
    }

    // Extended attributes
    xattr_ls {
      [[Lists all extended attributes asynchronously.]]
      params {
         @in path: string; [[Path we want to list entries for]]
      }
      return: future<uint64, const(array<string>)>; [[Extended attributes]]
    }

    stat {
      [[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: ptr(Eina.Future) @owned; [[Future for asynchronous set operation]]
      }
      get {
         return: ptr(Eina.Future) @owned; [[Information]]
      }
      keys {
         path: string; [[File path]]
         attribute: string; [[Attribute name]]
      }
    }

    // helper api
    open {
      [[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: ptr(Eina.Future) @owned; [[Eina file handle]]
    }
    close {
      [[Closes an open Eina.File.]]
      params {
        @in file: ptr(Eina.File); [[Eina file handle]]
        // Here we're just interested whether the promise was fullfilled or not. No value needed.
      }
      return: ptr(Eina.Future) @owned; [[Close return code]]
    }
  }
}