Skip to content
XIDL

Compiler Pragmas

Compiler Pragmas

Section titled “Compiler Pragmas”

XIDL supports #pragma xidlc ... directives to provide extra configuration for the compiler and generators.

Basic Syntax

Section titled “Basic Syntax”
#pragma xidlc ...

package

Section titled “package”

Sets the package name, which maps to OpenAPI info.title:

#pragma xidlc package rev-tunnel
#pragma xidlc package "rev-tunnel"

version

Section titled “version”

Sets the package version, which maps to OpenAPI info.version:

#pragma xidlc version v1.0.0
#pragma xidlc version "1.0.0"

service

Section titled “service”

Declares an API endpoint with a service name. The name is optional and defaults to the endpoint:

#pragma xidlc service <api-endpoint> [api-name]

Example:

#pragma xidlc package E2E HTTP Stream Test
#pragma xidlc version v1.0.0
#pragma xidlc service http://127.0.0.1:8080 dev server
#pragma xidlc service http://127.0.0.1:8081 product

This defines a package named E2E HTTP Stream Test with version v1.0.0, containing two services: dev and product.

Section titled “Related Pages”