Struct Example 

pub struct Example<T>(pub T);

A transparent wrapper that carries a typed value for OpenAPI example.

Serializes/deserializes identically to T (transparent serde).

When the utoipa feature is enabled, the value is exposed as a schema example on the inner type. When the schemars feature is enabled, the wrapper delegates to T’s schema.

Examples

use api_bones::openapi::Example;

let ex = Example::new("hello");
assert_eq!(*ex, "hello");
assert_eq!(ex.into_inner(), "hello");

Tuple Fields

0: T

Implementations

impl<T> Example<T>

pub const fn new(value: T) -> Self

Wrap a value as an Example.

Examples

use api_bones::openapi::Example;

let ex = Example::new(42u32);
assert_eq!(ex.value(), &42);

pub const fn value(&self) -> &T

Borrow the inner value.

pub fn into_inner(self) -> T

Consume the wrapper and return the inner value.

Trait Implementations

impl<T: Clone> Clone for Example<T>

fn clone(&self) -> Example<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Example<T>

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

Formats the value using the given formatter.

impl<T> Deref for Example<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Example<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, T> Deserialize<'de> for Example<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<T> for Example<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Example<T>

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<T: Ord> Ord for Example<T>

fn cmp(&self, other: &Example<T>) -> 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<T: PartialEq> PartialEq for Example<T>

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

fn partial_cmp(&self, other: &Example<T>) -> 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<T> Serialize for Example<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq> Eq for Example<T>

impl<T> StructuralPartialEq for Example<T>