utoipa::openapi::schema

Enum KnownFormat

Help

pub enum KnownFormat {
Show 21 variants    Int32,
    Int64,
    Float,
    Double,
    Byte,
    Binary,
    Time,
    Date,
    DateTime,
    Duration,
    Password,
    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§

Int32

32 bit integer.

Int64

64 bit 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.

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§

impl Clone for KnownFormat

fn clone(&self) -> KnownFormat

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

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

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

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for KnownFormat

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.

impl Serialize for KnownFormat

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

Serialize this value into the given Serde serializer. Read more

impl Eq for KnownFormat

impl StructuralPartialEq for KnownFormat

Auto Trait Implementations§

impl Freeze for KnownFormat

impl RefUnwindSafe for KnownFormat

impl Send for KnownFormat

impl Sync for KnownFormat

impl Unpin for KnownFormat

impl UnwindSafe for KnownFormat

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

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

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

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

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