Skip to main content

SqlRoute

Struct SqlRoute 

Source
pub struct SqlRoute {
    pub metadata: Value,
    pub http: HttpAnnotations,
    pub param_locations: BTreeMap<String, HttpParamBinding>,
    pub default_status: u16,
    pub body_bundle_name: String,
    pub operation_id: String,
    pub handler_name: String,
}
Expand description

One spikard route plus the SQL command and HTTP semantics needed to wire it up. Returned as a single value so callers don’t lose the join between the route’s identity (path/method/handler name) and the query metadata that produced it.

Fields§

§metadata: Value

RouteMetadata shape spikard-core consumes. Stored as JSON to avoid a hard dep on spikard-core from spikard-codegen; callers (the CLI) deserialize into the concrete type at the boundary.

§http: HttpAnnotations

HTTP semantics that built the route — preserved so the OpenAPI emitter and sidecar builder don’t have to re-parse query.custom.

§param_locations: BTreeMap<String, HttpParamBinding>

Mapping from SQL param name to its HTTP source. Combines explicit @http_param overrides with the inference rules in bin_param_locations.

§default_status: u16

Status code chosen for the default response (from @http_status or derived from the SQL command).

§body_bundle_name: String

Bundle name for the body object when multiple body params exist.

§operation_id: String

operation_id used in OpenAPI (PascalCase, taken from @name).

§handler_name: String

Handler name in generated code (snake_case, handle_<name>).

Trait Implementations§

Source§

impl Clone for SqlRoute

Source§

fn clone(&self) -> SqlRoute

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 SqlRoute

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, 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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.