Struct MediaInputContent 

pub struct MediaInputContent {
    pub source: InputContentSource,
    pub metadata: Option<Value>,
}

An image, audio, video or document content part.

The four modalities share a shape, so they share a struct; which one it is is carried by the InputContent variant.

Fields

source: InputContentSource

Where the bytes are.

metadata: Option<Value>

Producer-defined extras (dimensions, page counts, alt text, …).

Implementations

impl MediaInputContent

pub fn new(source: InputContentSource) -> Self

Builds a media part from a source, with no metadata.

Trait Implementations

impl Clone for MediaInputContent

fn clone(&self) -> MediaInputContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for MediaInputContent

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for MediaInputContent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MediaInputContent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for MediaInputContent

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.

impl PartialEq for MediaInputContent

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MediaInputContent

impl ToSchema for MediaInputContent

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

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.