Struct Ref

#[non_exhaustive]
pub struct Ref {
    pub ref_location: String,
    pub description: String,
    pub summary: String,
}

Implements OpenAPI Reference Object that can be used to reference reusable components such as Schemas or Responses.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

ref_location: String

Reference location of the actual component.

description: String

A description which by default should override that of the referenced component. Description supports markdown syntax. If referenced object type does not support description this field does not have effect.

summary: String

A short summary which by default should override that of the referenced component. If referenced component does not support summary field this does not have effect.

Implementations

impl Ref

pub fn builder() -> RefBuilder

Create an instance of Ref using the builder syntax

impl Ref

pub fn new<I: Into<String>>(ref_location: I) -> Self

Construct a new Ref with custom ref location. In most cases this is not necessary and Ref::from_schema_name could be used instead.

pub fn from_schema_name<I: Into<String>>(schema_name: I) -> Self

Construct a new Ref from provided schema name. This will create a Ref that references the the reusable schemas.

pub fn from_response_name<I: Into<String>>(response_name: I) -> Self

Construct a new Ref from provided response name. This will create a Ref that references the reusable response.

Trait Implementations

impl Clone for Ref

fn clone(&self) -> Ref

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Ref

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

Formats the value using the given formatter.

impl Default for Ref

fn default() -> Ref

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Ref

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Ref> for Object

fn from(value: Ref) -> Self

Converts to this type from the input type.

impl From<Ref> for RefOr<Response>

fn from(r: Ref) -> Self

Converts to this type from the input type.

impl From<Ref> for Schema

fn from(r: Ref) -> Self

Converts to this type from the input type.

impl PartialEq for Ref

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Ref

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Ref

impl StructuralPartialEq for Ref