Struct Extension

pub struct Extension {
    pub ty: ExtensionTypeId,
    pub description: String,
    pub extension: Value,
}

Extension on a type. The extension allows to extend information

Fields

ty: ExtensionTypeId

The type definition contains the namespace and the type name.

description: String

Textual description of the extension.

extension: Value

The extension as JSON representation.

Implementations

impl Extension

pub fn builder() -> ExtensionBuilder<((), (), ())>

Create a builder for building Extension. On the builder, call .ty(...), .description(...), .extension(...) to set the values of the fields. Finally, call .build() to create the instance of Extension.

impl Extension

pub fn new<T: Into<ExtensionTypeId>, S: Into<String>>( ty: T, description: S, extension: Value, ) -> Extension

Constructs an extension from the given namespaced type with the given description, components, properties and extensions.

pub fn new_from_type<S: Into<String>>( namespace: S, type_name: S, description: S, extension: Value, ) -> Extension

Trait Implementations

impl Clone for Extension

fn clone(&self) -> Extension

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Extension

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Extension

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Extension> for TypeDefinition

fn from(extension: &Extension) -> Self

Converts to this type from the input type.

impl FromIterator<Extension> for Extensions

fn from_iter<I: IntoIterator<Item = Extension>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for Extension

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for Extension

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn always_inline_schema() -> bool

👎Deprecated: Use inline_schema() instead

Only included for backward-compatibility - use inline_schema() instead“.

impl NamespacedTypeGetter for Extension

fn namespace(&self) -> String

Returns the namespace of the type.

fn type_name(&self) -> String

Returns the name of the type.

impl Ord for Extension

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<ExtensionTypeId> for Extension

fn eq(&self, ty: &ExtensionTypeId) -> 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 PartialEq for Extension

fn eq(&self, other: &Extension) -> 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 PartialOrd for Extension

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Extension

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TypeDefinitionGetter for Extension

fn type_definition(&self) -> TypeDefinition

Returns the type definition of the type.

impl Eq for Extension

impl StructuralPartialEq for Extension