Struct ResolvedOpenAPI 

pub struct ResolvedOpenAPI { /* private fields */ }

OpenAPI with every $ref in the document replaced by the item it named.

Built with TryFrom<&OpenAPI>. Every reference to the same component resolves to the same Shared allocation, so Shared::as_ptr tells whether two sites named the same component, and the entries of components are those very allocations. The document is only ever borrowed from, never taken apart; see Shared for why.

Implementations

impl ResolvedOpenAPI

pub fn openapi(&self) -> &str

See OpenAPI::openapi.

pub fn info(&self) -> &Info

See OpenAPI::info.

pub fn servers(&self) -> &[Server]

See OpenAPI::servers.

pub fn paths(&self) -> &ResolvedPaths

See OpenAPI::paths.

pub fn components(&self) -> Option<&ResolvedComponents>

See OpenAPI::components.

pub fn security(&self) -> Option<&[SecurityRequirement]>

See OpenAPI::security.

pub fn tags(&self) -> &[Tag]

See OpenAPI::tags.

pub fn external_docs(&self) -> Option<&ExternalDocumentation>

See OpenAPI::external_docs.

pub fn extensions(&self) -> &IndexMap<String, Value>

See OpenAPI::extensions.

Trait Implementations

impl Debug for ResolvedOpenAPI

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

Formats the value using the given formatter.

impl PartialEq for ResolvedOpenAPI

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ResolvedOpenAPI

impl TryFrom<&OpenAPI> for ResolvedOpenAPI

fn try_from(openapi: &OpenAPI) -> Result<Self, Self::Error>

Resolves every $ref in the document.

Fails with the first reference that does not resolve. A schema that contains a reference back to itself is fine, and comes out with a NestedSchema edge that is recursive; any other component that contains itself has no finite tree form and fails with ResolveError::CyclicReference.

type Error = ResolveError

The type returned in the event of a conversion error.

impl TryFrom<OpenAPI> for ResolvedOpenAPI

type Error = ResolveError

The type returned in the event of a conversion error.

fn try_from(openapi: OpenAPI) -> Result<Self, Self::Error>

Performs the conversion.