Struct rweb::openapi::ComponentDescriptor

pub struct ComponentDescriptor { /* fields omitted */ }

Implementations

impl ComponentDescriptor

pub fn get_component(&self, name: &str) -> Option<&Schema>

Get a reference to the component named name, if such exists.

pub fn get_unpack<'a>(
    &'a self,
    schema: &'a ComponentOrInlineSchema
) -> &'a Schema

Get a reference to the schema of a type.

If schema is inline, it itself is returned, otherwise the component is looked up by name and its schema is returned.

Panics

Panics if schema refers to a non-existing component.

pub fn describe_component(
    &mut self,
    name: &str,
    desc: impl FnOnce(&mut ComponentDescriptor) -> Schema
) -> ComponentOrInlineSchema

Describes a component, iff it isn’t already described.

Parameters

• name: name of the component
• desc: descriptor function

Returns

Reference to the component

Circular references

To avoid infinite recursion on circular references, a blanket schema is stored under component name first, then the component is described and the schema replaced.

Note that this may cause invalid spec generation if somewhere in such loop there are types that rely on cloned modification of the schema of underlying component.

Trait Implementations

impl Debug for ComponentDescriptor

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

Formats the value using the given formatter.