Trait Component 

pub trait Component: Sealed + Sized {
    const SECTION: Section;

    // Required method
    fn section(
        openapi: &OpenAPI,
    ) -> Option<&IndexMap<String, ReferenceOr<Self>>>;
}

A type that $ref pointers can name.

Implemented for the nine #/components types and for PathItem. The type is what decides which section is searched, so a pointer into a different section is reported as ResolveError::SectionMismatch rather than silently missing.

Note that Callback is a transparent alias for IndexMap<String, PathItem> rather than a distinct type, so any value of that shape resolves as a callback. That is upstream’s design, not a choice this crate can undo.

This trait is sealed: it cannot be implemented outside this crate. That keeps Self::SECTION and Self::section in agreement, and it is what makes the blanket impls on ReferenceOr<T> and ReferenceOr<Box<T>> non-overlapping for good.

Required Associated Constants

const SECTION: Section

The section of the document holding values of this type.

Required Methods

fn section(openapi: &OpenAPI) -> Option<&IndexMap<String, ReferenceOr<Self>>>

Borrows that section, or None if the document omits it entirely.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl Component for Callback

const SECTION: Section = Section::Callbacks

fn section(openapi: &OpenAPI) -> Option<&IndexMap<String, ReferenceOr<Self>>>

impl Component for Example

const SECTION: Section = Section::Examples

fn section(openapi: &OpenAPI) -> Option<&IndexMap<String, ReferenceOr<Self>>>

impl Component for Header

const SECTION: Section = Section::Headers

fn section(openapi: &OpenAPI) -> Option<&IndexMap<String, ReferenceOr<Self>>>

impl Component for Link

const SECTION: Section = Section::Links

fn section(openapi: &OpenAPI) -> Option<&IndexMap<String, ReferenceOr<Self>>>

impl Component for Parameter

const SECTION: Section = Section::Parameters

fn section(openapi: &OpenAPI) -> Option<&IndexMap<String, ReferenceOr<Self>>>

impl Component for PathItem

const SECTION: Section = Section::Paths

fn section(openapi: &OpenAPI) -> Option<&IndexMap<String, ReferenceOr<Self>>>

impl Component for RequestBody

const SECTION: Section = Section::RequestBodies

fn section(openapi: &OpenAPI) -> Option<&IndexMap<String, ReferenceOr<Self>>>

impl Component for Response

const SECTION: Section = Section::Responses

fn section(openapi: &OpenAPI) -> Option<&IndexMap<String, ReferenceOr<Self>>>

impl Component for Schema

const SECTION: Section = Section::Schemas

fn section(openapi: &OpenAPI) -> Option<&IndexMap<String, ReferenceOr<Self>>>

impl Component for SecurityScheme

const SECTION: Section = Section::SecuritySchemes

fn section(openapi: &OpenAPI) -> Option<&IndexMap<String, ReferenceOr<Self>>>

Implementors