KnownFormat

Enum KnownFormat 

Source
pub enum KnownFormat {
Show 35 variants Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64, Float, Double, Byte, Binary, Time, Date, DateTime, Duration, Password, String, Decimal, Ulid, Uuid, Url, UriReference, Iri, IriReference, Email, IdnEmail, Hostname, IdnHostname, Ipv4, Ipv6, UriTemplate, JsonPointer, RelativeJsonPointer, Regex,
}
Expand description

Known schema format modifier property to provide fine detail of the primitive type.

Known format is defined in https://spec.openapis.org/oas/latest.html#data-types and https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-7.3 as well as by few known data types that are enabled by specific feature flag e.g. uuid.

Variants§

§

Int8

8 bit integer.

§

Int16

16 bit integer.

§

Int32

32 bit integer.

§

Int64

64 bit integer.

§

UInt8

8 bit unsigned integer.

§

UInt16

16 bit unsigned integer.

§

UInt32

32 bit unsigned integer.

§

UInt64

64 bit unsigned integer.

§

Float

floating point number.

§

Double

double (floating point) number.

§

Byte

base64 encoded chars.

§

Binary

binary data (octet).

§

Time

ISO-8601 full time format RFC3339.

§

Date

ISO-8601 full date RFC3339.

§

DateTime

ISO-8601 full date time RFC3339.

§

Duration

duration format from RFC3339 Appendix-A.

§

Password

Hint to UI to obscure input.

§

String

Use for compact string

§

Decimal

Available on crate features decimal or decimal-float only.

Used with String values to indicate value is in decimal format.

decimal feature need to be enabled.

§

Ulid

Available on crate feature ulid only.

Used with String values to indicate value is in ULID format.

§

Uuid

Available on crate feature uuid only.

Used with String values to indicate value is in UUID format.

§

Url

Available on crate feature url only.

Used with String values to indicate value is in Url format.

url feature need to be enabled.

§

UriReference

Available on crate feature url only.

A string instance is valid against this attribute if it is a valid URI Reference (either a URI or a relative-reference) according to RFC3986.

§

Iri

Available on crate feature url only.

A string instance is valid against this attribute if it is a valid IRI, according to RFC3987.

§

IriReference

Available on crate feature url only.

A string instance is valid against this attribute if it is a valid IRI Reference (either an IRI or a relative-reference) according to RFC3987.

§

Email

As defined in “Mailbox” rule RFC5321.

§

IdnEmail

As defined by extended “Mailbox” rule RFC6531.

§

Hostname

As defined by RFC1123, including host names produced using the Punycode algorithm specified in RFC5891.

§

IdnHostname

As defined by either RFC1123 as for hostname, or an internationalized hostname as defined by RFC5890.

§

Ipv4

An IPv4 address according to RFC2673.

§

Ipv6

An IPv6 address according to RFC4291.

§

UriTemplate

A string instance is a valid URI Template if it is according to RFC6570.

Note! There are no separate IRL template.

§

JsonPointer

A valid JSON string representation of a JSON Pointer according to RFC6901.

§

RelativeJsonPointer

A valid relative JSON Pointer according to draft-handrews-relative-json-pointer-01.

§

Regex

Regular expression, which SHOULD be valid according to the ECMA-262.

Trait Implementations§

Source§

impl Clone for KnownFormat

Source§

fn clone(&self) -> KnownFormat

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KnownFormat

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for KnownFormat

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for KnownFormat

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for KnownFormat

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for KnownFormat

Source§

impl StructuralPartialEq for KnownFormat

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,