Struct oapi::OApiParameter

pub struct OApiParameter { /* fields omitted */ }

The OpenApi parameter object

Implementations

impl OApiParameter

pub fn name(&self) -> &String

Name of the parameter

pub fn in_(&self) -> &OApiParameterLocation

Position of the parameter

pub fn description(&self) -> &Option<String>

Description of the parameter

pub fn required(&self) -> &Option<bool>

Mark the parameter as mandatory

pub fn deprecated(&self) -> &bool

Mark the parameter as deprecated

pub fn allow_empty_value(&self) -> &bool

Mark if the parameter should allow empty values

pub fn style(&self) -> &Option<OApiParameterStyle>

Style of the parameter

pub fn explode(&self) -> &bool

Mark if the parameter should be exploded

pub fn allow_reserved(&self) -> &bool

Mark if the paramter should allow reserved characters

pub fn schema(&self) -> &Option<OperatorSelector<OApiSchema>>

Schema description the parameter

pub fn example(&self) -> &Option<OApiExampleSelector>

Example object for the parameter

Trait Implementations

impl Clone for OApiParameter

fn clone(&self) -> OApiParameter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OApiParameter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OApiParameter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl OApiCheckTrait for OApiParameter

fn oapi_check(
    &self,
    root: &SparseRoot<OApiDocument>,
    bread_crumb: &mut Vec<String>
) -> Result<(), OApiError>

Check the current object, if any checks are to be performed, then checks its inner attributes

fn oapi_check_inner(
    &self,
    root: &SparseRoot<OApiDocument>,
    bread_crumb: &mut Vec<String>
) -> Result<(), OApiError>

Check every inner attributes of the object

impl OApiExtensionExtractor for OApiParameter

fn oapi_raw_ext(&self) -> &HashMap<String, Value>

Return a map of value of the additionnal keys for that object

fn oapi_extract_ext<S>(
    &self,
    root: &SparseRoot<OApiDocument>,
    key: &str
) -> Result<S, OApiError> where
    S: DeserializeOwned + SparsableTrait + Serialize + OApiCheckTrait, 

Try to deserialize to the type S the object at key, providing the root of the document for any SparsePointer dereferencing

impl PartialEq<OApiParameter> for OApiParameter

fn eq(&self, other: &OApiParameter) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &OApiParameter) -> bool

This method tests for !=.

impl Serialize for OApiParameter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Sparsable for OApiParameter

fn sparse_init(
    &mut self,
    state: &mut SparseState,
    metadata: &SparseMetadata,
    depth: u32
) -> Result<(), SparseError>

Initialize recusively a Sparsable pointer

pub fn sparse_updt(
    &mut self,
    state: &mut SparseState,
    metadata: &SparseMetadata,
    depth: u32
) -> Result<(), SparseError>

Update recusively a Sparsable pointer

pub fn check_depth(&self, depth: u32) -> Result<(), SparseError>

Check if the current depth isn’t too much. This is the cyclic pointer protection mechanism

impl StructuralPartialEq for OApiParameter