Struct opg::models::Components

pub struct Components {
    pub schemas: BTreeMap<String, Model>,
    pub security_schemes: BTreeMap<String, SecurityScheme>,
}

Components Object

specification

Fields

schemas: BTreeMap<String, Model>

An object to hold reusable Schema Objects

security_schemes: BTreeMap<String, SecurityScheme>

An object to hold reusable Security Scheme Objects

Implementations

impl Components

pub fn new() -> Self

pub fn contains_model(&self, name: &str) -> bool

Check name occurrence in schemas

pub fn mention_schema<M: ?Sized>(
    &mut self,
    inline: bool,
    params: &ContextParams
) -> ModelReference where
    M: OpgModel, 

Insert model into schema and return it's reference

pub fn mention_security_scheme<T>(
    &mut self,
    name: String,
    security_scheme: &T
) -> String where
    T: Clone,
    SecurityScheme: From<T>, 

Insert security scheme and return it's name

pub fn verify_schemas(&self) -> Result<(), String>

Verify schemas references

pub fn add_model<N>(&mut self, name: N, model: Model) where
    N: ToString, 

Manually insert model with specified name

Trait Implementations

impl Clone for Components

fn clone(&self) -> Components

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Components

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

Formats the value using the given formatter.

impl Default for Components

fn default() -> Components

Returns the "default value" for a type.

impl Serialize for Components

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.