Skip to main content

CodeGenOutput

Struct CodeGenOutput 

Source
pub struct CodeGenOutput {
    pub common: Option<PathBuf>,
    pub models: Option<PathBuf>,
    pub models_subdir: String,
    pub server: Option<PathBuf>,
    pub client: Option<PathBuf>,
    pub generate_resource_clients: bool,
    pub python: Option<PathBuf>,
    pub node: Option<PathBuf>,
    pub node_ts: Option<PathBuf>,
    pub wasm: Option<PathBuf>,
}
Expand description

Output directory configuration for code generation.

All outputs are optional — set to None to skip that output entirely. For example, a server-only crate can omit client, and a client-only crate can omit server and common.

Fields§

§common: Option<PathBuf>

Output directory for the Axum request extractors. Generation is skipped when None; the server output needs it.

§models: Option<PathBuf>

Parent models directory (e.g. crates/common/src/models).

When Some, the generator writes labels.rs, pyo3_impls.rs, and mod.rs into a subdirectory named models_subdir inside this path. The buf proto plugin co-locates the compiled model files (<pkg>.rs / .serde.rs / .tonic.rs) in that same subdirectory, so the mod.rs includes them with include!("./<pkg>.rs").

§models_subdir: String

Name of the generated subdirectory inside models.

Defaults to "_gen".

§server: Option<PathBuf>

Output directory for server-side handler and route code. Generation is skipped when None.

§client: Option<PathBuf>

Output directory for HTTP client code. Generation is skipped when None.

§generate_resource_clients: bool

Whether to also emit ergonomic resource-scoped clients (<service>/resource.rs) alongside the low-level per-service client and builders.

A scoped client (e.g. CatalogClient bound to a name) captures the resource’s name components and exposes get/update/delete (+ resource-targeted custom RPCs) returning the matching builder. Only emitted for resource-scoped services, and only when client is Some. Defaults to false.

§python: Option<PathBuf>

Output directory for Python bindings. Generation is skipped when None.

§node: Option<PathBuf>

Output directory for Node.js NAPI bindings. Generation is skipped when None.

§node_ts: Option<PathBuf>

Output directory for Node.js TypeScript client. Generation is skipped when None.

§wasm: Option<PathBuf>

Output directory for WASM/browser #[wasm_bindgen] bindings + .d.ts. Generation is skipped when None.

Emits a #[wasm_bindgen] wrapper layer over the generated (WASM-transport) clients plus a client.d.ts for JS/TS consumers. Request/response values cross the boundary as plain JS objects via serde-wasm-bindgen, so this pairs with runtime: Buffa (serde-native models) and transport_type_path = "olai_http_wasm::WasmClient".

Implementations§

Source§

impl CodeGenOutput

Source

pub fn models_subdir_path(&self) -> Option<PathBuf>

Absolute path of the generated subdirectory (models/models_subdir), if models is set.

Trait Implementations§

Source§

impl Clone for CodeGenOutput

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CodeGenOutput

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more