pub struct OApiTag { /* private fields */ }
Expand description
§The OpenApi tag object
Implementations§
Source§impl OApiTag
impl OApiTag
Sourcepub fn description(&self) -> &Option<String>
pub fn description(&self) -> &Option<String>
A description of the tag
Sourcepub fn external_docs(&self) -> &Option<OApiExternalDocumentation>
pub fn external_docs(&self) -> &Option<OApiExternalDocumentation>
External documentation for the tag
Trait Implementations§
Source§impl<'de> Deserialize<'de> for OApiTag
impl<'de> Deserialize<'de> for OApiTag
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Source§impl OApiCheckTrait for OApiTag
impl OApiCheckTrait for OApiTag
Source§fn oapi_check(
&self,
root: &SparseRoot<OApiDocument>,
bread_crumb: &mut Vec<String>,
) -> Result<(), OApiError>
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
Source§fn oapi_check_inner(
&self,
root: &SparseRoot<OApiDocument>,
bread_crumb: &mut Vec<String>,
) -> Result<(), OApiError>
fn oapi_check_inner( &self, root: &SparseRoot<OApiDocument>, bread_crumb: &mut Vec<String>, ) -> Result<(), OApiError>
Check every inner attributes of the object
Source§impl OApiExtensionExtractor for OApiTag
impl OApiExtensionExtractor for OApiTag
Source§fn oapi_raw_ext(&self) -> &HashMap<String, Value>
fn oapi_raw_ext(&self) -> &HashMap<String, Value>
Return a map of value of the additionnal keys for that object
Source§fn oapi_extract_ext<S>(
&self,
root: &SparseRoot<OApiDocument>,
key: &str,
) -> Result<S, OApiError>
fn oapi_extract_ext<S>( &self, root: &SparseRoot<OApiDocument>, key: &str, ) -> Result<S, OApiError>
Try to deserialize to the type
S
the object at key
, providing the
root of the document for any SparsePointer dereferencingSource§impl Sparsable for OApiTag
impl Sparsable for OApiTag
Source§fn sparse_init(
&mut self,
state: &mut SparseState,
metadata: &SparseMetadata,
depth: u32,
) -> Result<(), SparseError>
fn sparse_init( &mut self, state: &mut SparseState, metadata: &SparseMetadata, depth: u32, ) -> Result<(), SparseError>
Initialize recusively a Sparsable pointer
Source§fn sparse_updt(
&mut self,
state: &mut SparseState,
metadata: &SparseMetadata,
depth: u32,
) -> Result<(), SparseError>
fn sparse_updt( &mut self, state: &mut SparseState, metadata: &SparseMetadata, depth: u32, ) -> Result<(), SparseError>
Update recusively a Sparsable pointer
Source§fn check_depth(&self, depth: u32) -> Result<(), SparseError>
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 OApiTag
Auto Trait Implementations§
impl Freeze for OApiTag
impl RefUnwindSafe for OApiTag
impl Send for OApiTag
impl Sync for OApiTag
impl Unpin for OApiTag
impl UnwindSafe for OApiTag
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