Struct oapi::OApiComponents

pub struct OApiComponents { /* fields omitted */ }

The OpenApi components

Implementations

impl OApiComponents

pub fn links(&self) -> &HashMap<String, OApiLink>

A map of reusable links

pub fn schemas(&self) -> &HashMap<String, OperatorSelector<OApiSchema>>

A map of reusable schemas

pub fn responses(&self) -> &HashMap<String, OApiResponse>

A map of reusable responses

pub fn parameters(&self) -> &HashMap<String, OApiParameter>

A map of reusable parameters

pub fn examples(&self) -> &HashMap<String, OApiExampleSelector>

A map of reusable examples

pub fn request_bodies(&self) -> &HashMap<String, OApiRequestBody>

A map of reusable request bodies

pub fn headers(&self) -> &HashMap<String, OApiHeader>

A map of reusable headers

pub fn security_schemes(&self) -> &HashMap<String, OApiSecurityScheme>

A map of reusable security schemes

pub fn callbacks(&self) -> &HashMap<String, OApiCallback>

A map of reusable callbacks

Trait Implementations

impl Clone for OApiComponents

fn clone(&self) -> OApiComponents

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OApiComponents

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

Formats the value using the given formatter.

impl Default for OApiComponents

fn default() -> OApiComponents

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OApiComponents where
    OApiComponents: Default, 

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

Deserialize this value from the given Serde deserializer.

impl OApiCheckTrait for OApiComponents

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 OApiComponents

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<OApiComponents> for OApiComponents

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

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

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

This method tests for !=.

impl Serialize for OApiComponents

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 OApiComponents

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 OApiComponents