Struct dropshot::ApiEndpointParameter
source · pub struct ApiEndpointParameter {
pub metadata: ApiEndpointParameterMetadata,
pub description: Option<String>,
pub required: bool,
pub schema: ApiSchemaGenerator,
pub examples: Vec<String>,
}
Expand description
ApiEndpointParameter represents the discrete path and query parameters for a given API endpoint. These are typically derived from the members of stucts used as parameters to handler functions.
Fields§
§metadata: ApiEndpointParameterMetadata
§description: Option<String>
§required: bool
§schema: ApiSchemaGenerator
§examples: Vec<String>
Implementations§
source§impl ApiEndpointParameter
impl ApiEndpointParameter
pub fn new_named( loc: &ApiEndpointParameterLocation, name: String, description: Option<String>, required: bool, schema: ApiSchemaGenerator, examples: Vec<String> ) -> Self
pub fn new_body( content_type: ApiEndpointBodyContentType, required: bool, schema: ApiSchemaGenerator, examples: Vec<String> ) -> Self
Trait Implementations§
Auto Trait Implementations§
impl RefUnwindSafe for ApiEndpointParameter
impl Send for ApiEndpointParameter
impl Sync for ApiEndpointParameter
impl Unpin for ApiEndpointParameter
impl UnwindSafe for ApiEndpointParameter
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
Mutably borrows from an owned value. Read more