Class
VipsTarget
Description [src]
class Vips.Target : Vips.Connection {
parent_object: VipsConnection
}A VipsTarget provides a unified interface for writing data to various
output destinations.
This target could be a socket, file, memory area, or any other destination that accepts byte data.
Constructors
vips_target_new_temp
Create a temporary target — either a temporary file on disc, or an area in
memory, depending on what sort of target based_on is.
vips_target_new_to_descriptor
Create a target attached to a file descriptor.
descriptor is kept open until the target is finalized.
vips_target_new_to_file
Create a target attached to a file.
vips_target_new_to_memory
Create a target which will write to a memory area. Read from blob to get memory.
Instance methods
vips_target_end
Call this at the end of write to make the target do any cleaning up. You can call it many times.
vips_target_putc
Write a single character ch to target. See the macro VIPS_TARGET_PUTC()
for a faster way to do this.
vips_target_read
Read up to length bytes from target and store the bytes in buffer.
Return the number of bytes actually read. If all bytes have been read from
the file, return 0.
vips_target_seek
Seek the target. This behaves exactly as lseek().
vips_target_steal
Memory targets only (see vips_target_new_to_memory()). Steal all data
written to the target so far, and call vips_target_end().
vips_target_steal_text
As vips_target_steal(), but return a null-terminated string.
vips_target_write
Write length bytes from data to the output.
vips_target_write_amp
Write str to target, but escape stuff that xml hates in text. Our
argument string is utf-8.
vips_target_writef
Format the string and write to target.
vips_target_writes
Write a null-terminated string to target.
Methods inherited from VipsConnection (2)
Methods inherited from VipsObject (27)
Methods inherited from GObject (42)
Properties
Vips.Target:blob
Vips.Target:memory
Properties inherited from VipsConnection (2)
Vips.Connection:descriptor
Vips.Connection:filename
Properties inherited from VipsObject (2)
Signals
Signals inherited from VipsObject (4)
Vips.Object::close
The ::close signal is emitted once during object close. The object is dying and may not work.
Vips.Object::postbuild
The ::postbuild signal is emitted once just after successful object construction. Return non-zero to cause object construction to fail.
Vips.Object::postclose
The ::postclose signal is emitted once after object close. The object pointer is still valid, but nothing else.
Vips.Object::preclose
The ::preclose signal is emitted once just before object close starts. The object is still alive.
Signals inherited from GObject (1)
GObject.Object::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Class structure
struct VipsTargetClass {
VipsConnectionClass parent_class;
gint64 (* write) (
VipsTarget* target,
void* data,
size_t length
);
void (* finish) (
VipsTarget* target
);
gint64 (* read) (
VipsTarget* target,
void* buffer,
size_t length
);
gint64 (* seek) (
VipsTarget* target,
gint64 offset,
int whence
);
int (* end) (
VipsTarget* target
);
}Class members
parent_class |
|
| No description available. | |
write |
|
| No description available. | |
finish |
|
| No description available. | |
read |
|
| No description available. | |
seek |
|
| No description available. | |
end |
|
| No description available. |
Virtual methods
Vips.TargetClass.end
Call this at the end of write to make the target do any cleaning up. You can call it many times.
Vips.TargetClass.finish
Vips.TargetClass.read
Read up to length bytes from target and store the bytes in buffer.
Return the number of bytes actually read. If all bytes have been read from
the file, return 0.
Vips.TargetClass.seek
Seek the target. This behaves exactly as lseek().