Crate webui_ffi 

WebUI FFI (Foreign Function Interface) for interoperability with other languages.

This crate provides C-compatible APIs for the WebUI handler to be used from languages like Go, C#, Python, etc.

Load a compiled protocol once with webui_protocol_create, then reuse the handle with webui_handler_render and the other protocol operations.

Error Handling

All functions that can fail return NULL on error. Call webui_last_error to retrieve a human-readable error message. The error string is valid until the next FFI call on the same thread (follows the POSIX dlerror() pattern).

Functions

webui_free^⚠

Free a string returned by a WebUI FFI function.

webui_handler_create

Create a new WebUI handler instance.

webui_handler_create_with_plugin^⚠

Create a new WebUI handler instance with a named plugin.

webui_handler_destroy^⚠

Destroy a WebUI handler instance.

webui_handler_render^⚠

Render using a protocol previously returned by webui_protocol_create.

webui_handler_set_nonce^⚠

Set the CSP nonce for inline <script> tags on a handler instance.

webui_last_error

Return the last error message, or NULL if no error has occurred.

webui_protocol_create^⚠

Decode and index a WebUI protocol for repeated rendering.

webui_protocol_destroy^⚠

Destroy a loaded WebUI protocol handle.

webui_protocol_render_component_templates^⚠

Render component templates using a loaded protocol handle.

webui_protocol_render_partial^⚠

Produce a complete partial response using a loaded protocol handle.

webui_protocol_tokens^⚠

Extract CSS token names from a loaded protocol handle.

webui_streaming_session_boundary^⚠

Resolve an authored boundary name to a stable integer handle.

webui_streaming_session_boundary_count^⚠

Return the number of compile-time boundaries declared by this entry.

webui_streaming_session_create^⚠

Open a host-driven progressive response for a streaming entry.

webui_streaming_session_destroy^⚠

Release a streaming session handle.

webui_streaming_session_finish^⚠

Render the document tail and emit the terminal record.

webui_streaming_session_is_finished^⚠

Report whether the terminal record has been written.

webui_streaming_session_update^⚠

Push a projected state patch to a committed updatable boundary.

webui_streaming_session_write_boundary^⚠

Render and commit the next boundary in declaration order.

webui_streaming_session_write_shell^⚠

Render everything before the first boundary.

Type Aliases

webui_protocol_t

Opaque C handle for a loaded WebUI protocol.

webui_streaming_session_t

Opaque C handle for a host-driven progressive response.