summaryrefslogtreecommitdiff
path: root/pages/develop/api/efl/io/buffer
diff options
context:
space:
mode:
authorAndy Williams <andy@andywilliams.me>2017-12-11 16:59:35 +0000
committerAndy Williams <andy@andywilliams.me>2017-12-11 16:59:49 +0000
commit2782d0c642dcea66ee93d10fa12d78f130e66cdb (patch)
treebd3a7c81cff9903b042a11a1c30efc8760c617ff /pages/develop/api/efl/io/buffer
parent7dd88611a2938001370bdbac9b72b4a25854a2d0 (diff)
Updated Unified API docs with latest generator
Diffstat (limited to 'pages/develop/api/efl/io/buffer')
-rw-r--r--pages/develop/api/efl/io/buffer/event/position_read_changed.txt41
-rw-r--r--pages/develop/api/efl/io/buffer/event/position_write_changed.txt41
-rw-r--r--pages/develop/api/efl/io/buffer/event/reallocated.txt41
-rw-r--r--pages/develop/api/efl/io/buffer/method/adopt_readonly.txt34
-rw-r--r--pages/develop/api/efl/io/buffer/method/adopt_readwrite.txt36
-rw-r--r--pages/develop/api/efl/io/buffer/method/binbuf_steal.txt30
-rw-r--r--pages/develop/api/efl/io/buffer/method/close.txt30
-rw-r--r--pages/develop/api/efl/io/buffer/method/destructor.txt24
-rw-r--r--pages/develop/api/efl/io/buffer/method/finalize.txt24
-rw-r--r--pages/develop/api/efl/io/buffer/method/preallocate.txt32
-rw-r--r--pages/develop/api/efl/io/buffer/method/read.txt37
-rw-r--r--pages/develop/api/efl/io/buffer/method/resize.txt33
-rw-r--r--pages/develop/api/efl/io/buffer/method/seek.txt35
-rw-r--r--pages/develop/api/efl/io/buffer/method/write.txt39
-rw-r--r--pages/develop/api/efl/io/buffer/property/can_read.txt40
-rw-r--r--pages/develop/api/efl/io/buffer/property/can_write.txt40
-rw-r--r--pages/develop/api/efl/io/buffer/property/close_on_destructor.txt42
-rw-r--r--pages/develop/api/efl/io/buffer/property/close_on_exec.txt52
-rw-r--r--pages/develop/api/efl/io/buffer/property/closed.txt50
-rw-r--r--pages/develop/api/efl/io/buffer/property/eos.txt40
-rw-r--r--pages/develop/api/efl/io/buffer/property/limit.txt53
-rw-r--r--pages/develop/api/efl/io/buffer/property/position.txt50
-rw-r--r--pages/develop/api/efl/io/buffer/property/position_read.txt45
-rw-r--r--pages/develop/api/efl/io/buffer/property/position_write.txt45
-rw-r--r--pages/develop/api/efl/io/buffer/property/size.txt50
-rw-r--r--pages/develop/api/efl/io/buffer/property/slice.txt30
26 files changed, 1014 insertions, 0 deletions
diff --git a/pages/develop/api/efl/io/buffer/event/position_read_changed.txt b/pages/develop/api/efl/io/buffer/event/position_read_changed.txt
new file mode 100644
index 0000000..0d67dcc
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/event/position_read_changed.txt
@@ -0,0 +1,41 @@
1~~Title: Efl.Io.Buffer: position_read,changed~~
2===== Signature =====
3
4<code>
5position_read,changed;
6</code>
7
8===== C information =====
9
10<code c>
11EFL_IO_BUFFER_EVENT_POSITION_READ_CHANGED(void)
12</code>
13
14===== C usage =====
15
16<code c>
17static void
18on_efl_io_buffer_event_position_read_changed(void *data, const Efl_Event *event)
19{
20 void info = event->info;
21 Eo *obj = event->object;
22 Data *d = data;
23
24 /* event hander code */
25}
26
27static void
28setup_event_handler(Eo *obj, Data *d)
29{
30 efl_event_callback_add(obj, EFL_IO_BUFFER_EVENT_POSITION_READ_CHANGED, on_efl_io_buffer_event_position_read_changed, d);
31}
32
33</code>
34
35===== Description =====
36
37%%Notifies %%[[:develop:api:class:efl:io:buffer:property:position_read|Efl.Io.Buffer.position_read]]%% changed%%
38
39//Since 1.19//
40{{page>:develop:api-include:efl:io:buffer:event:position_read_changed:description&nouser&nolink&nodate}}
41
diff --git a/pages/develop/api/efl/io/buffer/event/position_write_changed.txt b/pages/develop/api/efl/io/buffer/event/position_write_changed.txt
new file mode 100644
index 0000000..562730b
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/event/position_write_changed.txt
@@ -0,0 +1,41 @@
1~~Title: Efl.Io.Buffer: position_write,changed~~
2===== Signature =====
3
4<code>
5position_write,changed;
6</code>
7
8===== C information =====
9
10<code c>
11EFL_IO_BUFFER_EVENT_POSITION_WRITE_CHANGED(void)
12</code>
13
14===== C usage =====
15
16<code c>
17static void
18on_efl_io_buffer_event_position_write_changed(void *data, const Efl_Event *event)
19{
20 void info = event->info;
21 Eo *obj = event->object;
22 Data *d = data;
23
24 /* event hander code */
25}
26
27static void
28setup_event_handler(Eo *obj, Data *d)
29{
30 efl_event_callback_add(obj, EFL_IO_BUFFER_EVENT_POSITION_WRITE_CHANGED, on_efl_io_buffer_event_position_write_changed, d);
31}
32
33</code>
34
35===== Description =====
36
37%%Notifies %%[[:develop:api:class:efl:io:buffer:property:position_write|Efl.Io.Buffer.position_write]]%% changed%%
38
39//Since 1.19//
40{{page>:develop:api-include:efl:io:buffer:event:position_write_changed:description&nouser&nolink&nodate}}
41
diff --git a/pages/develop/api/efl/io/buffer/event/reallocated.txt b/pages/develop/api/efl/io/buffer/event/reallocated.txt
new file mode 100644
index 0000000..da6c295
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/event/reallocated.txt
@@ -0,0 +1,41 @@
1~~Title: Efl.Io.Buffer: reallocated~~
2===== Signature =====
3
4<code>
5reallocated;
6</code>
7
8===== C information =====
9
10<code c>
11EFL_IO_BUFFER_EVENT_REALLOCATED(void)
12</code>
13
14===== C usage =====
15
16<code c>
17static void
18on_efl_io_buffer_event_reallocated(void *data, const Efl_Event *event)
19{
20 void info = event->info;
21 Eo *obj = event->object;
22 Data *d = data;
23
24 /* event hander code */
25}
26
27static void
28setup_event_handler(Eo *obj, Data *d)
29{
30 efl_event_callback_add(obj, EFL_IO_BUFFER_EVENT_REALLOCATED, on_efl_io_buffer_event_reallocated, d);
31}
32
33</code>
34
35===== Description =====
36
37%%Notifies the internal buffer was reallocated, thus whatever was returned by %%[[:develop:api:class:efl:io:buffer:property:slice|Efl.Io.Buffer.slice]]%% becomes invalid%%
38
39//Since 1.19//
40{{page>:develop:api-include:efl:io:buffer:event:reallocated:description&nouser&nolink&nodate}}
41
diff --git a/pages/develop/api/efl/io/buffer/method/adopt_readonly.txt b/pages/develop/api/efl/io/buffer/method/adopt_readonly.txt
new file mode 100644
index 0000000..9dbf84f
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/method/adopt_readonly.txt
@@ -0,0 +1,34 @@
1~~Title: Efl.Io.Buffer.adopt_readonly~~
2===== Signature =====
3
4<code>
5adopt_readonly {
6 params {
7 @in slice: const(Eina.Slice);
8 }
9}
10</code>
11
12===== C signature =====
13
14<code c>
15void efl_io_buffer_adopt_readonly(Eo *obj, const Eina_Slice slice);
16</code>
17
18===== Parameters =====
19
20 * **slice** //(in)// - %%Slice to adopt as read-only%%
21
22===== Description =====
23
24%%Adopt a read-only slice as buffer's backing store.%%
25
26%%The slice memory will not be copied and must remain alive during buffer's lifetime. Usually this is guaranteed by some global static-const memory or some parent object and this buffer being a view of that -- be aware of parent memory remaining alive, such as "slice,changed" events.%%
27
28//Since 1.19//
29{{page>:develop:api-include:efl:io:buffer:method:adopt_readonly:description&nouser&nolink&nodate}}
30
31===== Implemented by =====
32
33 * **Efl.Io.Buffer.adopt_readonly**
34
diff --git a/pages/develop/api/efl/io/buffer/method/adopt_readwrite.txt b/pages/develop/api/efl/io/buffer/method/adopt_readwrite.txt
new file mode 100644
index 0000000..4afddbe
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/method/adopt_readwrite.txt
@@ -0,0 +1,36 @@
1~~Title: Efl.Io.Buffer.adopt_readwrite~~
2===== Signature =====
3
4<code>
5adopt_readwrite {
6 params {
7 @in slice: Eina.Rw_Slice;
8 }
9}
10</code>
11
12===== C signature =====
13
14<code c>
15void efl_io_buffer_adopt_readwrite(Eo *obj, Eina_Rw_Slice slice);
16</code>
17
18===== Parameters =====
19
20 * **slice** //(in)// - %%Slice to adopt as read-write%%
21
22===== Description =====
23
24%%Adopt a read-write slice as buffer's backing store.%%
25
26%%The slice memory will not be copied and must remain alive during buffer's lifetime. Usually this is guaranteed by some global static memory or some parent object and this buffer being a view of that -- be aware of parent memory remaining alive, such as "slice,changed" events.%%
27
28%%The memory will be disposed using free() and reallocated using realloc().%%
29
30//Since 1.19//
31{{page>:develop:api-include:efl:io:buffer:method:adopt_readwrite:description&nouser&nolink&nodate}}
32
33===== Implemented by =====
34
35 * **Efl.Io.Buffer.adopt_readwrite**
36
diff --git a/pages/develop/api/efl/io/buffer/method/binbuf_steal.txt b/pages/develop/api/efl/io/buffer/method/binbuf_steal.txt
new file mode 100644
index 0000000..2acc2dd
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/method/binbuf_steal.txt
@@ -0,0 +1,30 @@
1~~Title: Efl.Io.Buffer.binbuf_steal~~
2===== Signature =====
3
4<code>
5binbuf_steal {
6 return: ptr(free(Eina.Binbuf, eina_binbuf_free)) @warn_unused;
7}
8</code>
9
10===== C signature =====
11
12<code c>
13Eina_Binbuf *efl_io_buffer_binbuf_steal(Eo *obj);
14</code>
15
16===== Description =====
17
18%%Steals the internal buffer memory and returns it as a binbuf.%%
19
20%%The returned memory must be freed with eina_binbuf_free().%%
21
22%%On failure, for example a read-only backing store was adopted with %%[[:develop:api:class:efl:io:buffer:method:adopt_readonly|Efl.Io.Buffer.adopt_readonly]]%%, NULL is returned.%%
23
24//Since 1.19//
25{{page>:develop:api-include:efl:io:buffer:method:binbuf_steal:description&nouser&nolink&nodate}}
26
27===== Implemented by =====
28
29 * **Efl.Io.Buffer.binbuf_steal**
30
diff --git a/pages/develop/api/efl/io/buffer/method/close.txt b/pages/develop/api/efl/io/buffer/method/close.txt
new file mode 100644
index 0000000..1b52f10
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/method/close.txt
@@ -0,0 +1,30 @@
1~~Title: Efl.Io.Buffer.close~~
2//Overridden from [[:develop:api:efl:io:closer:method:close|Efl.Io.Closer.close]].//===== Signature =====
3
4<code>
5close @pure_virtual {
6 return: Eina.Error;
7}
8</code>
9
10===== C signature =====
11
12<code c>
13Eina_Error efl_io_closer_close(Eo *obj);
14</code>
15
16===== Description =====
17
18%%Closes the Input/Output object.%%
19
20%%This operation will be executed immediately and may or may not block the caller thread for some time. The details of blocking behavior is to be defined by the implementation and may be subject to other parameters such as non-blocking flags, maximum timeout or even retry attempts.%%
21
22%%You can understand this method as close(2) libc function.%%
23
24//Since 1.19//
25{{page>:develop:api-include:efl:io:buffer:method:close:description&nouser&nolink&nodate}}
26
27===== Implemented by =====
28
29 * [[:develop:api:efl:io:closer:method:close|Efl.Io.Closer.close]]
30
diff --git a/pages/develop/api/efl/io/buffer/method/destructor.txt b/pages/develop/api/efl/io/buffer/method/destructor.txt
new file mode 100644
index 0000000..7736e30
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/method/destructor.txt
@@ -0,0 +1,24 @@
1~~Title: Efl.Io.Buffer.destructor~~
2//Overridden from [[:develop:api:efl:object:method:destructor|Efl.Object.destructor]].//===== Signature =====
3
4<code>
5destructor {}
6</code>
7
8===== C signature =====
9
10<code c>
11void efl_destructor(Eo *obj);
12</code>
13
14===== Description =====
15
16%%Call the object's destructor.%%
17
18%%Should not be used with #eo_do. Only use it with #eo_do_super.%%
19{{page>:develop:api-include:efl:io:buffer:method:destructor:description&nouser&nolink&nodate}}
20
21===== Implemented by =====
22
23 * [[:develop:api:efl:object:method:destructor|Efl.Object.destructor]]
24
diff --git a/pages/develop/api/efl/io/buffer/method/finalize.txt b/pages/develop/api/efl/io/buffer/method/finalize.txt
new file mode 100644
index 0000000..021072f
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/method/finalize.txt
@@ -0,0 +1,24 @@
1~~Title: Efl.Io.Buffer.finalize~~
2//Overridden from [[:develop:api:efl:object:method:finalize|Efl.Object.finalize]].//===== Signature =====
3
4<code>
5finalize {
6 return: free(Efl.Object, efl_del);
7}
8</code>
9
10===== C signature =====
11
12<code c>
13Efl_Object *efl_finalize(Eo *obj);
14</code>
15
16===== Description =====
17
18%%Called at the end of #eo_add. Should not be called, just overridden.%%
19{{page>:develop:api-include:efl:io:buffer:method:finalize:description&nouser&nolink&nodate}}
20
21===== Implemented by =====
22
23 * [[:develop:api:efl:object:method:finalize|Efl.Object.finalize]]
24
diff --git a/pages/develop/api/efl/io/buffer/method/preallocate.txt b/pages/develop/api/efl/io/buffer/method/preallocate.txt
new file mode 100644
index 0000000..15e42b3
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/method/preallocate.txt
@@ -0,0 +1,32 @@
1~~Title: Efl.Io.Buffer.preallocate~~
2===== Signature =====
3
4<code>
5preallocate {
6 params {
7 @in size: size;
8 }
9}
10</code>
11
12===== C signature =====
13
14<code c>
15void efl_io_buffer_preallocate(Eo *obj, size_t size);
16</code>
17
18===== Parameters =====
19
20 * **size** //(in)// - %%Amount of bytes to pre-allocate.%%
21
22===== Description =====
23
24%%Immediately pre-allocate a buffer of at least a given size.%%
25
26//Since 1.19//
27{{page>:develop:api-include:efl:io:buffer:method:preallocate:description&nouser&nolink&nodate}}
28
29===== Implemented by =====
30
31 * **Efl.Io.Buffer.preallocate**
32
diff --git a/pages/develop/api/efl/io/buffer/method/read.txt b/pages/develop/api/efl/io/buffer/method/read.txt
new file mode 100644
index 0000000..2d80f99
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/method/read.txt
@@ -0,0 +1,37 @@
1~~Title: Efl.Io.Buffer.read~~
2//Overridden from [[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]].//===== Signature =====
3
4<code>
5read @pure_virtual {
6 params {
7 @inout rw_slice: Eina.Rw_Slice @nonull;
8 }
9 return: Eina.Error;
10}
11</code>
12
13===== C signature =====
14
15<code c>
16Eina_Error efl_io_reader_read(Eo *obj, Eina_Rw_Slice rw_slice);
17</code>
18
19===== Parameters =====
20
21 * **rw_slice** //(inout)// - %%Provides a pre-allocated memory to be filled up to rw_slice.len. It will be populated and the length will be set to the actually used amount of bytes, which can be smaller than the request.%%
22
23===== Description =====
24
25%%Reads data into a pre-allocated buffer.%%
26
27%%This operation will be executed immediately and may or may not block the caller thread for some time. The details of blocking behavior is to be defined by the implementation and may be subject to other parameters such as non-blocking flags, maximum timeout or even retry attempts.%%
28
29%%You can understand this method as read(2) libc function.%%
30
31//Since 1.19//
32{{page>:develop:api-include:efl:io:buffer:method:read:description&nouser&nolink&nodate}}
33
34===== Implemented by =====
35
36 * [[:develop:api:efl:io:reader:method:read|Efl.Io.Reader.read]]
37
diff --git a/pages/develop/api/efl/io/buffer/method/resize.txt b/pages/develop/api/efl/io/buffer/method/resize.txt
new file mode 100644
index 0000000..e065b22
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/method/resize.txt
@@ -0,0 +1,33 @@
1~~Title: Efl.Io.Buffer.resize~~
2//Overridden from [[:develop:api:efl:io:sizer:method:resize|Efl.Io.Sizer.resize]].//===== Signature =====
3
4<code>
5resize @pure_virtual {
6 params {
7 @in size: uint64;
8 }
9 return: Eina.Error;
10}
11</code>
12
13===== C signature =====
14
15<code c>
16Eina_Error efl_io_sizer_resize(Eo *obj, uint64_t size);
17</code>
18
19===== Parameters =====
20
21 * **size** //(in)// - %%Object size%%
22
23===== Description =====
24
25%%Resize object%%
26
27//Since 1.19//
28{{page>:develop:api-include:efl:io:buffer:method:resize:description&nouser&nolink&nodate}}
29
30===== Implemented by =====
31
32 * [[:develop:api:efl:io:sizer:method:resize|Efl.Io.Sizer.resize]]
33
diff --git a/pages/develop/api/efl/io/buffer/method/seek.txt b/pages/develop/api/efl/io/buffer/method/seek.txt
new file mode 100644
index 0000000..04aa753
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/method/seek.txt
@@ -0,0 +1,35 @@
1~~Title: Efl.Io.Buffer.seek~~
2//Overridden from [[:develop:api:efl:io:positioner:method:seek|Efl.Io.Positioner.seek]].//===== Signature =====
3
4<code>
5seek @pure_virtual {
6 params {
7 @in offset: int64;
8 @in whence: Efl.Io.Positioner.Whence;
9 }
10 return: Eina.Error;
11}
12</code>
13
14===== C signature =====
15
16<code c>
17Eina_Error efl_io_positioner_seek(Eo *obj, int64_t offset, Efl_Io_Positioner_Whence whence);
18</code>
19
20===== Parameters =====
21
22 * **offset** //(in)// - %%Offset in byte relative to whence%%
23 * **whence** //(in)// - %%Whence%%
24
25===== Description =====
26
27%%Seek in data%%
28
29//Since 1.19//
30{{page>:develop:api-include:efl:io:buffer:method:seek:description&nouser&nolink&nodate}}
31
32===== Implemented by =====
33
34 * [[:develop:api:efl:io:positioner:method:seek|Efl.Io.Positioner.seek]]
35
diff --git a/pages/develop/api/efl/io/buffer/method/write.txt b/pages/develop/api/efl/io/buffer/method/write.txt
new file mode 100644
index 0000000..6542383
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/method/write.txt
@@ -0,0 +1,39 @@
1~~Title: Efl.Io.Buffer.write~~
2//Overridden from [[:develop:api:efl:io:writer:method:write|Efl.Io.Writer.write]].//===== Signature =====
3
4<code>
5write @pure_virtual {
6 params {
7 @inout slice: Eina.Slice @nonull;
8 @out remaining: Eina.Slice @optional;
9 }
10 return: Eina.Error;
11}
12</code>
13
14===== C signature =====
15
16<code c>
17Eina_Error efl_io_writer_write(Eo *obj, Eina_Slice slice, Eina_Slice *remaining);
18</code>
19
20===== Parameters =====
21
22 * **slice** //(inout)// - %%Provides a pre-populated memory to be used up to slice.len. The returned slice will be adapted as length will be set to the actually used amount of bytes, which can be smaller than the request.%%
23 * **remaining** //(out)// - %%Convenience to output the remaining parts of slice that was not written. If the full slice was written, this will be a slice of zero-length.%%
24
25===== Description =====
26
27%%Writes data from a pre-populated buffer.%%
28
29%%This operation will be executed immediately and may or may not block the caller thread for some time. The details of blocking behavior is to be defined by the implementation and may be subject to other parameters such as non-blocking flags, maximum timeout or even retry attempts.%%
30
31%%You can understand this method as write(2) libc function.%%
32
33//Since 1.19//
34{{page>:develop:api-include:efl:io:buffer:method:write:description&nouser&nolink&nodate}}
35
36===== Implemented by =====
37
38 * [[:develop:api:efl:io:writer:method:write|Efl.Io.Writer.write]]
39
diff --git a/pages/develop/api/efl/io/buffer/property/can_read.txt b/pages/develop/api/efl/io/buffer/property/can_read.txt
new file mode 100644
index 0000000..03f3fe2
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/property/can_read.txt
@@ -0,0 +1,40 @@
1~~Title: Efl.Io.Buffer.can_read~~
2//Overridden from [[:develop:api:efl:io:reader:property:can_read|Efl.Io.Reader.can_read]] **(get, set)**.//===== Signature =====
3
4<code>
5@property can_read @pure_virtual {
6 get {
7 values {
8 can_read: bool;
9 }
10 }
11 set @protected {
12 values {
13 can_read: bool;
14 }
15 }
16}
17</code>
18
19===== C signature =====
20
21<code c>
22Eina_Bool efl_io_reader_can_read_get(const Eo *obj);
23void efl_io_reader_can_read_set(Eo *obj, Eina_Bool can_read);
24</code>
25
26===== Values =====
27
28 * **can_read** - %%%%''true''%% if it can be read without blocking or failing, %%''false''%% otherwise%%
29===== Description =====
30
31%%If %%''true''%% will notify %%[[:develop:api:interface:efl:io:reader:method:read|Efl.Io.Reader.read]]%% can be called without blocking or failing.%%
32
33//Since 1.19//
34{{page>:develop:api-include:efl:io:buffer:property:can_read:description&nouser&nolink&nodate}}
35
36
37===== Implemented by =====
38
39 * [[:develop:api:efl:io:reader:property:can_read|Efl.Io.Reader.can_read]]
40
diff --git a/pages/develop/api/efl/io/buffer/property/can_write.txt b/pages/develop/api/efl/io/buffer/property/can_write.txt
new file mode 100644
index 0000000..2c11be1
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/property/can_write.txt
@@ -0,0 +1,40 @@
1~~Title: Efl.Io.Buffer.can_write~~
2//Overridden from [[:develop:api:efl:io:writer:property:can_write|Efl.Io.Writer.can_write]] **(get, set)**.//===== Signature =====
3
4<code>
5@property can_write @pure_virtual {
6 get {
7 values {
8 can_write: bool;
9 }
10 }
11 set @protected {
12 values {
13 can_write: bool;
14 }
15 }
16}
17</code>
18
19===== C signature =====
20
21<code c>
22Eina_Bool efl_io_writer_can_write_get(const Eo *obj);
23void efl_io_writer_can_write_set(Eo *obj, Eina_Bool can_write);
24</code>
25
26===== Values =====
27
28 * **can_write** - %%%%''true''%% if it can be written without blocking or failure, %%''false''%% otherwise%%
29===== Description =====
30
31%%If %%''true''%% will notify %%[[:develop:api:interface:efl:io:writer:method:write|Efl.Io.Writer.write]]%% can be called without blocking or failing.%%
32
33//Since 1.19//
34{{page>:develop:api-include:efl:io:buffer:property:can_write:description&nouser&nolink&nodate}}
35
36
37===== Implemented by =====
38
39 * [[:develop:api:efl:io:writer:property:can_write|Efl.Io.Writer.can_write]]
40
diff --git a/pages/develop/api/efl/io/buffer/property/close_on_destructor.txt b/pages/develop/api/efl/io/buffer/property/close_on_destructor.txt
new file mode 100644
index 0000000..3cbbb54
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/property/close_on_destructor.txt
@@ -0,0 +1,42 @@
1~~Title: Efl.Io.Buffer.close_on_destructor~~
2//Overridden from [[:develop:api:efl:io:closer:property:close_on_destructor|Efl.Io.Closer.close_on_destructor]] **(get, set)**.//===== Signature =====
3
4<code>
5@property close_on_destructor @pure_virtual {
6 get {
7 values {
8 close_on_destructor: bool;
9 }
10 }
11 set {
12 values {
13 close_on_destructor: bool;
14 }
15 }
16}
17</code>
18
19===== C signature =====
20
21<code c>
22Eina_Bool efl_io_closer_close_on_destructor_get(const Eo *obj);
23void efl_io_closer_close_on_destructor_set(Eo *obj, Eina_Bool close_on_destructor);
24</code>
25
26===== Values =====
27
28 * **close_on_destructor** - %%%%''true''%% if close on destructor, %%''false''%% otherwise%%
29===== Description =====
30
31%%If true will automatically close() on object destructor.%%
32
33%%If the object was deleted without close, this property will state whenever it should be closed or not.%%
34
35//Since 1.19//
36{{page>:develop:api-include:efl:io:buffer:property:close_on_destructor:description&nouser&nolink&nodate}}
37
38
39===== Implemented by =====
40
41 * [[:develop:api:efl:io:closer:property:close_on_destructor|Efl.Io.Closer.close_on_destructor]]
42
diff --git a/pages/develop/api/efl/io/buffer/property/close_on_exec.txt b/pages/develop/api/efl/io/buffer/property/close_on_exec.txt
new file mode 100644
index 0000000..b3af7b5
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/property/close_on_exec.txt
@@ -0,0 +1,52 @@
1~~Title: Efl.Io.Buffer.close_on_exec~~
2//Overridden from [[:develop:api:efl:io:closer:property:close_on_exec|Efl.Io.Closer.close_on_exec]] **(get, set)**.//===== Signature =====
3
4<code>
5@property close_on_exec @pure_virtual {
6 get {
7 values {
8 close_on_exec: bool;
9 }
10 }
11 set {
12 values {
13 close_on_exec: bool;
14 }
15 return: bool;
16 }
17}
18</code>
19
20===== C signature =====
21
22<code c>
23Eina_Bool efl_io_closer_close_on_exec_get(const Eo *obj);
24Eina_Bool efl_io_closer_close_on_exec_set(Eo *obj, Eina_Bool close_on_exec);
25</code>
26
27===== Values =====
28
29 * **close_on_exec** - %%%%''true''%% if close on exec(), %%''false''%% otherwise%%
30===== Description =====
31
32%%If true will automatically close resources on exec() calls.%%
33
34%%When using file descriptors this should set FD_CLOEXEC so they are not inherited by the processes (children or self) doing exec().%%
35
36//Since 1.19//
37
38
39{{page>:develop:api-include:efl:io:buffer:property:close_on_exec:description&nouser&nolink&nodate}}
40
41==== Setter ====
42
43%%If %%''true''%%, will close on exec() call.%%
44
45//Since 1.19//
46{{page>:develop:api-include:efl:io:buffer:property:close_on_exec:getter_description&nouser&nolink&nodate}}
47
48
49===== Implemented by =====
50
51 * [[:develop:api:efl:io:closer:property:close_on_exec|Efl.Io.Closer.close_on_exec]]
52
diff --git a/pages/develop/api/efl/io/buffer/property/closed.txt b/pages/develop/api/efl/io/buffer/property/closed.txt
new file mode 100644
index 0000000..c42ebb2
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/property/closed.txt
@@ -0,0 +1,50 @@
1~~Title: Efl.Io.Buffer.closed~~
2//Overridden from [[:develop:api:efl:io:closer:property:closed|Efl.Io.Closer.closed]] **(get)**.//===== Signature =====
3
4<code>
5@property closed {
6 get {
7 values {
8 is_closed: bool;
9 }
10 }
11 set {
12 values {
13 is_closed: bool;
14 }
15 return: bool;
16 }
17}
18</code>
19
20===== C signature =====
21
22<code c>
23Eina_Bool efl_io_closer_closed_get(const Eo *obj);
24Eina_Bool efl_io_closer_closed_set(Eo *obj, Eina_Bool is_closed);
25</code>
26
27===== Values =====
28
29 * **is_closed** - %%%%''true''%% if closed, %%''false''%% otherwise%%
30===== Description =====
31
32%%If true will notify object was closed.%%
33
34//Since 1.19//
35
36
37{{page>:develop:api-include:efl:io:buffer:property:closed:description&nouser&nolink&nodate}}
38
39==== Setter ====
40
41%%If true, calls close()%%
42
43//Since 1.19//
44{{page>:develop:api-include:efl:io:buffer:property:closed:getter_description&nouser&nolink&nodate}}
45
46
47===== Implemented by =====
48
49 * [[:develop:api:efl:io:closer:property:closed|Efl.Io.Closer.closed]]
50
diff --git a/pages/develop/api/efl/io/buffer/property/eos.txt b/pages/develop/api/efl/io/buffer/property/eos.txt
new file mode 100644
index 0000000..fbcc2a9
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/property/eos.txt
@@ -0,0 +1,40 @@
1~~Title: Efl.Io.Buffer.eos~~
2//Overridden from [[:develop:api:efl:io:reader:property:eos|Efl.Io.Reader.eos]] **(get, set)**.//===== Signature =====
3
4<code>
5@property eos @pure_virtual {
6 get {
7 values {
8 is_eos: bool;
9 }
10 }
11 set @protected {
12 values {
13 is_eos: bool;
14 }
15 }
16}
17</code>
18
19===== C signature =====
20
21<code c>
22Eina_Bool efl_io_reader_eos_get(const Eo *obj);
23void efl_io_reader_eos_set(Eo *obj, Eina_Bool is_eos);
24</code>
25
26===== Values =====
27
28 * **is_eos** - %%%%''true''%% if end of stream, %%''false''%% otherwise%%
29===== Description =====
30
31%%If %%''true''%% will notify end of stream.%%
32
33//Since 1.19//
34{{page>:develop:api-include:efl:io:buffer:property:eos:description&nouser&nolink&nodate}}
35
36
37===== Implemented by =====
38
39 * [[:develop:api:efl:io:reader:property:eos|Efl.Io.Reader.eos]]
40
diff --git a/pages/develop/api/efl/io/buffer/property/limit.txt b/pages/develop/api/efl/io/buffer/property/limit.txt
new file mode 100644
index 0000000..85eaab7
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/property/limit.txt
@@ -0,0 +1,53 @@
1~~Title: Efl.Io.Buffer.limit~~
2===== Signature =====
3
4<code>
5@property limit {
6 get {
7 values {
8 size: size;
9 }
10 }
11 set {
12 values {
13 size: size;
14 }
15 }
16}
17</code>
18
19===== C signature =====
20
21<code c>
22size_t efl_io_buffer_limit_get(const Eo *obj);
23void efl_io_buffer_limit_set(Eo *obj, size_t size);
24</code>
25
26===== Values =====
27
28 * **size** - %%Defines a maximum buffer size, or 0 to allow unlimited amount of bytes%%
29===== Description =====
30
31%%Limit how big the buffer can grow.%%
32
33%%This affects both %%[[:develop:api:class:efl:io:buffer:method:preallocate|Efl.Io.Buffer.preallocate]]%% and how buffer grows when %%[[:develop:api:interface:efl:io:writer:method:write|Efl.Io.Writer.write]]%% is called.%%
34
35%%If you want a buffer of an exact size, always set the limit before any further calls that can grow it.%%
36
37//Since 1.19//
38
39
40{{page>:develop:api-include:efl:io:buffer:property:limit:description&nouser&nolink&nodate}}
41
42==== Setter ====
43
44%%Constructor-only property to set buffer limit. 0 is unlimited%%
45
46//Since 1.19//
47{{page>:develop:api-include:efl:io:buffer:property:limit:getter_description&nouser&nolink&nodate}}
48
49
50===== Implemented by =====
51
52 * **Efl.Io.Buffer.limit**
53
diff --git a/pages/develop/api/efl/io/buffer/property/position.txt b/pages/develop/api/efl/io/buffer/property/position.txt
new file mode 100644
index 0000000..f6b2641
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/property/position.txt
@@ -0,0 +1,50 @@
1~~Title: Efl.Io.Buffer.position~~
2//Overridden from [[:develop:api:efl:io:positioner:property:position|Efl.Io.Positioner.position]] **(get)**.//===== Signature =====
3
4<code>
5@property position {
6 get {
7 values {
8 position: uint64;
9 }
10 }
11 set {
12 values {
13 position: uint64;
14 }
15 return: bool;
16 }
17}
18</code>
19
20===== C signature =====
21
22<code c>
23uint64_t efl_io_positioner_position_get(const Eo *obj);
24Eina_Bool efl_io_positioner_position_set(Eo *obj, uint64_t position);
25</code>
26
27===== Values =====
28
29 * **position** - %%Position in file or buffer%%
30===== Description =====
31
32%%Position property%%
33
34//Since 1.19//
35
36
37{{page>:develop:api-include:efl:io:buffer:property:position:description&nouser&nolink&nodate}}
38
39==== Setter ====
40
41%%Try to set position object, relative to start of file. See %%[[:develop:api:mixin:efl:io:positioner:method:seek|Efl.Io.Positioner.seek]]%%()%%
42
43//Since 1.19//
44{{page>:develop:api-include:efl:io:buffer:property:position:getter_description&nouser&nolink&nodate}}
45
46
47===== Implemented by =====
48
49 * [[:develop:api:efl:io:positioner:property:position|Efl.Io.Positioner.position]]
50
diff --git a/pages/develop/api/efl/io/buffer/property/position_read.txt b/pages/develop/api/efl/io/buffer/property/position_read.txt
new file mode 100644
index 0000000..f1a2b7d
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/property/position_read.txt
@@ -0,0 +1,45 @@
1~~Title: Efl.Io.Buffer.position_read~~
2===== Signature =====
3
4<code>
5@property position_read {
6 get {
7 values {
8 position: uint64;
9 }
10 }
11 set {
12 values {
13 position: uint64;
14 }
15 return: bool (false);
16 }
17}
18</code>
19
20===== C signature =====
21
22<code c>
23uint64_t efl_io_buffer_position_read_get(const Eo *obj);
24Eina_Bool efl_io_buffer_position_read_set(Eo *obj, uint64_t position);
25</code>
26
27===== Values =====
28
29 * **position** - %%Position in buffer%%
30===== Description =====
31
32%%The position used by %%[[:develop:api:interface:efl:io:reader:method:read|Efl.Io.Reader.read]]%%.%%
33
34%%Note that %%[[:develop:api:mixin:efl:io:positioner:method:seek|Efl.Io.Positioner.seek]]%% or %%[[:develop:api:mixin:efl:io:positioner:property:position|Efl.Io.Positioner.position.set]]%% will affect this property and %%[[:develop:api:class:efl:io:buffer:property:position_write|Efl.Io.Buffer.position_write]]%%.%%
35
36%%%%[[:develop:api:mixin:efl:io:positioner:property:position|Efl.Io.Positioner.position.get]]%% will return the greatest of %%[[:develop:api:class:efl:io:buffer:property:position_read|Efl.Io.Buffer.position_read]]%% and %%[[:develop:api:class:efl:io:buffer:property:position_write|Efl.Io.Buffer.position_write]]%%.%%
37
38//Since 1.19//
39{{page>:develop:api-include:efl:io:buffer:property:position_read:description&nouser&nolink&nodate}}
40
41
42===== Implemented by =====
43
44 * **Efl.Io.Buffer.position_read**
45
diff --git a/pages/develop/api/efl/io/buffer/property/position_write.txt b/pages/develop/api/efl/io/buffer/property/position_write.txt
new file mode 100644
index 0000000..8eb1ca0
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/property/position_write.txt
@@ -0,0 +1,45 @@
1~~Title: Efl.Io.Buffer.position_write~~
2===== Signature =====
3
4<code>
5@property position_write {
6 get {
7 values {
8 position: uint64;
9 }
10 }
11 set {
12 values {
13 position: uint64;
14 }
15 return: bool (false);
16 }
17}
18</code>
19
20===== C signature =====
21
22<code c>
23uint64_t efl_io_buffer_position_write_get(const Eo *obj);
24Eina_Bool efl_io_buffer_position_write_set(Eo *obj, uint64_t position);
25</code>
26
27===== Values =====
28
29 * **position** - %%Position in buffer%%
30===== Description =====
31
32%%The position used by %%[[:develop:api:interface:efl:io:writer:method:write|Efl.Io.Writer.write]]%%.%%
33
34%%Note that %%[[:develop:api:mixin:efl:io:positioner:method:seek|Efl.Io.Positioner.seek]]%% or %%[[:develop:api:mixin:efl:io:positioner:property:position|Efl.Io.Positioner.position.set]]%% will affect this property and %%[[:develop:api:class:efl:io:buffer:property:position_read|Efl.Io.Buffer.position_read]]%%.%%
35
36%%%%[[:develop:api:mixin:efl:io:positioner:property:position|Efl.Io.Positioner.position.get]]%% will return the greatest of %%[[:develop:api:class:efl:io:buffer:property:position_read|Efl.Io.Buffer.position_read]]%% and %%[[:develop:api:class:efl:io:buffer:property:position_write|Efl.Io.Buffer.position_write]]%%.%%
37
38//Since 1.19//
39{{page>:develop:api-include:efl:io:buffer:property:position_write:description&nouser&nolink&nodate}}
40
41
42===== Implemented by =====
43
44 * **Efl.Io.Buffer.position_write**
45
diff --git a/pages/develop/api/efl/io/buffer/property/size.txt b/pages/develop/api/efl/io/buffer/property/size.txt
new file mode 100644
index 0000000..de372bb
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/property/size.txt
@@ -0,0 +1,50 @@
1~~Title: Efl.Io.Buffer.size~~
2//Overridden from [[:develop:api:efl:io:sizer:property:size|Efl.Io.Sizer.size]] **(get)**.//===== Signature =====
3
4<code>
5@property size {
6 get {
7 values {
8 size: uint64;
9 }
10 }
11 set {
12 values {
13 size: uint64;
14 }
15 return: bool;
16 }
17}
18</code>
19
20===== C signature =====
21
22<code c>
23uint64_t efl_io_sizer_size_get(const Eo *obj);
24Eina_Bool efl_io_sizer_size_set(Eo *obj, uint64_t size);
25</code>
26
27===== Values =====
28
29 * **size** - %%Object size%%
30===== Description =====
31
32%%Size property%%
33
34//Since 1.19//
35
36
37{{page>:develop:api-include:efl:io:buffer:property:size:description&nouser&nolink&nodate}}
38
39==== Setter ====
40
41%%Try to resize the object, check with get if the value was accepted or not.%%
42
43//Since 1.19//
44{{page>:develop:api-include:efl:io:buffer:property:size:getter_description&nouser&nolink&nodate}}
45
46
47===== Implemented by =====
48
49 * [[:develop:api:efl:io:sizer:property:size|Efl.Io.Sizer.size]]
50
diff --git a/pages/develop/api/efl/io/buffer/property/slice.txt b/pages/develop/api/efl/io/buffer/property/slice.txt
new file mode 100644
index 0000000..2f33046
--- /dev/null
+++ b/pages/develop/api/efl/io/buffer/property/slice.txt
@@ -0,0 +1,30 @@
1~~Title: Efl.Io.Buffer.slice~~
2===== Signature =====
3
4<code>
5@property slice {
6 get {
7 values {
8 slice: Eina.Slice;
9 }
10 }
11}
12</code>
13
14===== C signature =====
15
16<code c>
17Eina_Slice efl_io_buffer_slice_get(const Eo *obj);
18</code>
19
20===== Values =====
21
22 * **slice** - %%Slice of the current buffer, may be invalidated if %%[[:develop:api:interface:efl:io:writer:method:write|Efl.Io.Writer.write]]%%, %%[[:develop:api:mixin:efl:io:closer:method:close|Efl.Io.Closer.close]]%% or %%[[:develop:api:mixin:efl:io:sizer:method:resize|Efl.Io.Sizer.resize]]%% are called. It is the full slice, not a partial one starting at current position.%%
23
24
25{{page>:develop:api-include:efl:io:buffer:property:slice:description&nouser&nolink&nodate}}
26
27===== Implemented by =====
28
29 * **Efl.Io.Buffer.slice**
30