Skip to main content

Spec

Struct Spec 

Source
pub struct Spec<'a> {
    pub info: &'a Info,
    pub operations: Vec<SpecOperation<'a>>,
    pub schemas: IndexMap<&'a str, SpecType<'a>>,
}
Expand description

The intermediate representation of an OpenAPI document.

A Spec is a type tree lowered from a parsed document, with references still unresolved. Construct one with Spec::from_doc(), then pass it to RawGraph::new() to build the type graph.

Fields§

§info: &'a Info

The document’s info section: title, OpenAPI version, etc.

§operations: Vec<SpecOperation<'a>>

All operations extracted from the document’s paths section.

§schemas: IndexMap<&'a str, SpecType<'a>>

Named schemas from components/schemas, keyed by name.

Implementations§

Source§

impl<'a> Spec<'a>

Source

pub fn from_doc(arena: &'a Arena, doc: &'a Document) -> Result<Self, IrError>

Builds a Spec from a parsed OpenAPI Document.

Lowers each schema and operation to IR types, allocating all long-lived data in the arena. Returns an error if the document is malformed.

Trait Implementations§

Source§

impl<'a> Debug for Spec<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Spec<'a>

§

impl<'a> RefUnwindSafe for Spec<'a>

§

impl<'a> Send for Spec<'a>

§

impl<'a> Sync for Spec<'a>

§

impl<'a> Unpin for Spec<'a>

§

impl<'a> UnsafeUnpin for Spec<'a>

§

impl<'a> UnwindSafe for Spec<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.