Struct oapi::OApiDocument [−][src]
pub struct OApiDocument { /* fields omitted */ }
Implementations
impl OApiDocument
[src]
impl OApiDocument
[src]pub fn openapi(&self) -> &Version
[src]
The OAPI version used. Needs to be 3^
pub fn info(&self) -> &OApiInfo
[src]
Info about the current document
pub fn servers(&self) -> &Option<Vec<OApiServer>>
[src]
List of servers used in this document
pub fn paths(&self) -> &HashMap<String, OApiPathItem>
[src]
List of paths this documents defines.
pub fn components(&self) -> &Option<OApiComponents>
[src]
An optional object containing components re-used across the document
pub fn security(&self) -> &HashMap<String, SparseSelector<OApiSecurityScheme>>
[src]
The security used for this API
pub fn tags(&self) -> &Option<Vec<OApiTag>>
[src]
Tags used to categorize the operations of this document
pub fn external_docs(&self) -> &Option<OApiExternalDocumentation>
[src]
Link to some external documentation, if any
impl OApiDocument
[src]
impl OApiDocument
[src]pub fn get_operation_id(&self, opid_searched: &str) -> Option<&OApiOperation>
[src]
Get an operation providing its Id
Trait Implementations
impl Clone for OApiDocument
[src]
impl Clone for OApiDocument
[src]fn clone(&self) -> OApiDocument
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'de> Deserialize<'de> for OApiDocument
[src]
impl<'de> Deserialize<'de> for OApiDocument
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl OApiCheckTrait for OApiDocument
[src]
impl OApiCheckTrait for OApiDocument
[src]fn oapi_check(
&self,
root: &SparseRoot<OApiDocument>,
bread_crumb: &mut Vec<String>
) -> Result<(), OApiError>
[src]
&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>
[src]
&self,
root: &SparseRoot<OApiDocument>,
bread_crumb: &mut Vec<String>
) -> Result<(), OApiError>
impl OApiExtensionExtractor for OApiDocument
[src]
impl OApiExtensionExtractor for OApiDocument
[src]fn oapi_raw_ext(&self) -> &HashMap<String, Value>
[src]
fn oapi_extract_ext<S>(
&self,
root: &SparseRoot<OApiDocument>,
key: &str
) -> Result<S, OApiError> where
S: DeserializeOwned + SparsableTrait + Serialize + OApiCheckTrait,
[src]
&self,
root: &SparseRoot<OApiDocument>,
key: &str
) -> Result<S, OApiError> where
S: DeserializeOwned + SparsableTrait + Serialize + OApiCheckTrait,
impl PartialEq<OApiDocument> for OApiDocument
[src]
impl PartialEq<OApiDocument> for OApiDocument
[src]fn eq(&self, other: &OApiDocument) -> bool
[src]
fn ne(&self, other: &OApiDocument) -> bool
[src]
impl Serialize for OApiDocument
[src]
impl Serialize for OApiDocument
[src]impl Sparsable for OApiDocument
[src]
impl Sparsable for OApiDocument
[src]fn sparse_init(
&mut self,
state: &mut SparseState,
metadata: &SparseMetadata,
depth: u32
) -> Result<(), SparseError>
[src]
&mut self,
state: &mut SparseState,
metadata: &SparseMetadata,
depth: u32
) -> Result<(), SparseError>
pub fn sparse_updt(
&mut self,
state: &mut SparseState,
metadata: &SparseMetadata,
depth: u32
) -> Result<(), SparseError>
[src]
&mut self,
state: &mut SparseState,
metadata: &SparseMetadata,
depth: u32
) -> Result<(), SparseError>
pub fn check_depth(&self, depth: u32) -> Result<(), SparseError>
[src]
impl StructuralPartialEq for OApiDocument
[src]
impl StructuralPartialEq for OApiDocument
[src]Auto Trait Implementations
impl RefUnwindSafe for OApiDocument
impl RefUnwindSafe for OApiDocument
impl Send for OApiDocument
impl Send for OApiDocument
impl Sync for OApiDocument
impl Sync for OApiDocument
impl Unpin for OApiDocument
impl Unpin for OApiDocument
impl UnwindSafe for OApiDocument
impl UnwindSafe for OApiDocument