Module org.freedesktop.cairo

Package org.freedesktop.cairo

Interface WriteFunc

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface WriteFunc

WriteFunc is the type of function which is called when a backend needs to write data to an output stream. It is passed the closure which was specified by the user at the time the write function was registered, the data to write and the length of the data in bytes. The write function should throw IOException if all the data was not successfully written.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
default MemorySegment	toCallback(Arena arena)	Generates an upcall stub, a C function pointer that will call upcall(java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment, int).
default int	upcall(MemorySegment closure, MemorySegment data, int length)	The callback that is executed by native code.
void	write(byte[] data)	The function to implement as callback in a write operation to an output stream.

Method Details

write

void write(byte[] data)
    throws IOException

The function to implement as callback in a write operation to an output stream.

Parameters:

data - the data to write to the output stream

Throws:

IOException - to be thrown when an error occurs during the write operation

Since:

1.0

upcall

default int upcall(MemorySegment closure,
 MemorySegment data,
 int length)

The callback that is executed by native code. This method marshals the parameters and calls write(byte[]).

Parameters:

closure - ignored

data - the buffer from which to read the data

length - the amount of data to write

Returns:

Status.SUCCESS on success, or Status.WRITE_ERROR if an IOException occured.

Since:

1.0

toCallback

default MemorySegment toCallback(Arena arena)

Generates an upcall stub, a C function pointer that will call upcall(java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment, int).

Parameters:

arena - the arena in which the upcall stub will be allocated

Returns:

the function pointer of the upcall stub

Since:

1.0