pub struct ParamDef {
pub name: &'static str,
pub param_type: &'static str,
pub required: bool,
pub description: &'static str,
pub resolution_mode: IdResolutionMode,
}Expand description
Parameter type for help=true schema envelopes.
Declares the name, type hint, required flag, and one-line description for
a single verb parameter. Stored as a &'static slice on HandlerDef so
the registry can return it without any allocation at call time.
The param_type field is drawn from a closed vocabulary (e.g. "string",
"uuid", "boolean", "integer"), asserted as an exact set by a
registry-wide test. It does not validate the argument, but it is not
documentation-only either: the runtime derives each verb’s published JSON
Schema from it, so an unmapped spelling withholds that verb’s schema.
Fields§
§name: &'static strParameter name as used in the DSL (e.g. "id", "kind", "query").
param_type: &'static strType hint from the closed vocabulary (e.g. "string", "uuid", "boolean").
required: boolWhether the caller must supply this parameter.
description: &'static strOne-line human-readable description.
resolution_mode: IdResolutionModeIdentifier-resolution mode for param_type "uuid" or "array of uuid" parameters; IdResolutionMode::NotApplicable for every
other parameter type.
Trait Implementations§
impl Copy for ParamDef
impl Eq for ParamDef
impl StructuralPartialEq for ParamDef
Auto Trait Implementations§
impl Freeze for ParamDef
impl RefUnwindSafe for ParamDef
impl Send for ParamDef
impl Sync for ParamDef
impl Unpin for ParamDef
impl UnsafeUnpin for ParamDef
impl UnwindSafe for ParamDef
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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