Struct oapi::OApi

pub struct OApi { /* fields omitted */ }

OpenApi document

This is the main struct of this crate. It contains a fully parsed OpenApi Document wrapped in a SparseRoot to allow for Sparse Pointer expansion.

Implementations

impl OApi

pub fn doc(&self) -> &SparseRoot<OApiDocument>

impl OApi

pub fn check(&self) -> Result<(), OApiError>

Check the document for logic errors

pub fn new(doc: SparseRoot<OApiDocument>) -> Self

Create a new OApi

Methods from Deref<Target = SparseRoot<OApiDocument>>

pub fn check_version(&self) -> Result<(), SparseError>

Get the value this selector is managing, either by deserializing the pointed value or by directly returning the owned value.

pub fn root_get(&self) -> Result<SparseValue<'_, S>, SparseError>

Get the value this selector is managing, either by deserializing the pointed value or by directly returning the owned value.

pub fn save_to_disk(
    &self,
    format: Option<SparseFileFormat>
) -> Result<(), SparseError>

Save the state to disk in the specified format. If not format is specified, the format in which the document was read will be used. If the document was read from memory, it’ll be written in prettified JSON

pub fn state(&self) -> &Rc<RefCell<SparseState>>

pub fn metadata(&self) -> &SparseMetadata

Trait Implementations

impl Debug for OApi

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

Formats the value using the given formatter.

impl Deref for OApi

type Target = SparseRoot<OApiDocument>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<SparseRoot<OApiDocument>> for OApi

fn from(doc: SparseRoot<OApiDocument>) -> Self

Performs the conversion.