Skip to main content

UserInput

Enum UserInput 

Source
pub enum UserInput {
    Text {
        text: String,
        text_elements: Vec<TextElement>,
    },
    Image {
        detail: Option<ImageDetail>,
        url: String,
    },
    LocalImage {
        detail: Option<ImageDetail>,
        path: String,
    },
    Skill {
        name: String,
        path: String,
    },
    Mention {
        name: String,
        path: String,
    },
}
Expand description

UserInput

JSON schema
{
 "oneOf": [
   {
     "title": "TextUserInput",
     "type": "object",
     "required": [
       "text",
       "type"
     ],
     "properties": {
       "text": {
         "type": "string"
       },
       "text_elements": {
         "description": "UI-defined spans within `text` used to render or persist special elements.",
         "default": [],
         "type": "array",
         "items": {
           "$ref": "#/definitions/TextElement"
         }
       },
       "type": {
         "title": "TextUserInputType",
         "type": "string",
         "enum": [
           "text"
         ]
       }
     }
   },
   {
     "title": "ImageUserInput",
     "type": "object",
     "required": [
       "type",
       "url"
     ],
     "properties": {
       "detail": {
         "default": null,
         "anyOf": [
           {
             "$ref": "#/definitions/ImageDetail"
           },
           {
             "type": "null"
           }
         ]
       },
       "type": {
         "title": "ImageUserInputType",
         "type": "string",
         "enum": [
           "image"
         ]
       },
       "url": {
         "type": "string"
       }
     }
   },
   {
     "title": "LocalImageUserInput",
     "type": "object",
     "required": [
       "path",
       "type"
     ],
     "properties": {
       "detail": {
         "default": null,
         "anyOf": [
           {
             "$ref": "#/definitions/ImageDetail"
           },
           {
             "type": "null"
           }
         ]
       },
       "path": {
         "type": "string"
       },
       "type": {
         "title": "LocalImageUserInputType",
         "type": "string",
         "enum": [
           "localImage"
         ]
       }
     }
   },
   {
     "title": "SkillUserInput",
     "type": "object",
     "required": [
       "name",
       "path",
       "type"
     ],
     "properties": {
       "name": {
         "type": "string"
       },
       "path": {
         "type": "string"
       },
       "type": {
         "title": "SkillUserInputType",
         "type": "string",
         "enum": [
           "skill"
         ]
       }
     }
   },
   {
     "title": "MentionUserInput",
     "type": "object",
     "required": [
       "name",
       "path",
       "type"
     ],
     "properties": {
       "name": {
         "type": "string"
       },
       "path": {
         "type": "string"
       },
       "type": {
         "title": "MentionUserInputType",
         "type": "string",
         "enum": [
           "mention"
         ]
       }
     }
   }
 ]
}

Variants§

§

Text

TextUserInput

Fields

§text: String
§text_elements: Vec<TextElement>

UI-defined spans within text used to render or persist special elements.

§

Image

ImageUserInput

Fields

§

LocalImage

LocalImageUserInput

Fields

§path: String
§

Skill

SkillUserInput

Fields

§name: String
§path: String
§

Mention

MentionUserInput

Fields

§name: String
§path: String

Implementations§

Source§

impl UserInput

Source

pub fn text(text: impl Into<String>) -> Self

Trait Implementations§

Source§

impl Clone for UserInput

Source§

fn clone(&self) -> UserInput

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UserInput

Source§

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

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

impl<'de> Deserialize<'de> for UserInput

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 Serialize for UserInput

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

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

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

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

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> 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.
§

impl<T> WithSubscriber for T

§

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
§

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>,