Trait ComposeSchema 

pub trait ComposeSchema {
    // Required method
    fn compose(
        components: &mut Components,
        generics: Vec<RefOr<Schema>>,
    ) -> RefOr<Schema>;
}

Trait for composing schemas with generic type parameters.

ComposeSchema enables generic types to compose their schemas from externally-provided generic parameter schemas. This separates schema structure generation (compose) from naming and registration (ToSchema).

For non-generic types, the generics parameter is ignored and the schema is generated directly. For generic types, each element in generics corresponds to a type parameter’s schema, in declaration order.

Examples

Manual implementation for a generic wrapper type:

use salvo_oapi::{BasicType, Components, ComposeSchema, Object, RefOr, Schema};

struct Page<T> {
    items: Vec<T>,
    total: u64,
}

impl<T: ComposeSchema> ComposeSchema for Page<T> {
    fn compose(components: &mut Components, generics: Vec<RefOr<Schema>>) -> RefOr<Schema> {
        let t_schema = generics
            .first()
            .cloned()
            .unwrap_or_else(|| T::compose(components, vec![]));
        Object::new()
            .property("items", salvo_oapi::schema::Array::new().items(t_schema))
            .required("items")
            .property("total", Object::new().schema_type(BasicType::Integer))
            .required("total")
            .into()
    }
}

Required Methods

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

Compose a schema using the provided generic parameter schemas.

The components parameter allows registering nested schemas. The generics vector contains pre-resolved schemas for each type parameter, in the order they appear in the type definition.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl ComposeSchema for &str

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for IpAddr

fn compose( components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for Error

fn compose( components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for Value

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for bool

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for char

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for f32

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for f64

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for i8

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for i16

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for i32

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for i64

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for i128

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for isize

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for str

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for u8

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for u16

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for u32

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for u64

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for u128

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for usize

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for String

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for Ipv4Addr

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for Ipv6Addr

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for NaiveDate

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for NaiveDateTime

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for CompactString

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for Decimal

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for StatusError

fn compose( components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for Map<String, Value>

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for RawValue

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for Date

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for Duration

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for OffsetDateTime

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for PrimitiveDateTime

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for Ulid

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for Url

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for Uuid

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl ComposeSchema for Duration

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<K: ComposeSchema, V: ComposeSchema> ComposeSchema for BTreeMap<K, V>

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<K: ComposeSchema, V: ComposeSchema> ComposeSchema for HashMap<K, V>

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<K: ComposeSchema, V: ComposeSchema> ComposeSchema for IndexMap<K, V>

Available on crate feature indexmap only.

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<T> ComposeSchema for PhantomData<T>

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<T, E> ComposeSchema for Result<T, E>

where T: ComposeSchema, E: ComposeSchema,

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<T: TimeZone> ComposeSchema for DateTime<T>

Available on crate feature chrono only.

fn compose( _components: &mut Components, _generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<T: ComposeSchema + ToOwned> ComposeSchema for Cow<'_, T>

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<T: ComposeSchema + Array> ComposeSchema for SmallVec<T>

Available on crate feature smallvec only.

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<T: ComposeSchema> ComposeSchema for &[T]

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<T: ComposeSchema> ComposeSchema for Option<T>

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<T: ComposeSchema> ComposeSchema for [T]

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<T: ComposeSchema> ComposeSchema for Box<T>

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<T: ComposeSchema> ComposeSchema for BTreeSet<T>

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<T: ComposeSchema> ComposeSchema for LinkedList<T>

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<T: ComposeSchema> ComposeSchema for Rc<T>

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<T: ComposeSchema> ComposeSchema for Arc<T>

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<T: ComposeSchema> ComposeSchema for Vec<T>

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<T: ComposeSchema> ComposeSchema for RefCell<T>

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<T: ComposeSchema> ComposeSchema for HashSet<T>

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<T: ComposeSchema> ComposeSchema for IndexSet<T>

Available on crate feature indexmap only.

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

impl<T: ComposeSchema, const N: usize> ComposeSchema for [T; N]

fn compose( components: &mut Components, generics: Vec<RefOr<Schema>>, ) -> RefOr<Schema>

Implementors

impl ComposeSchema for TupleUnit