Struct UserMessageEvent 

pub struct UserMessageEvent {
    pub client_id: Option<String>,
    pub message: String,
    pub images: Option<Vec<String>>,
    pub image_details: Vec<Option<ImageDetail>>,
    pub local_images: Vec<PathBuf>,
    pub local_image_details: Vec<Option<ImageDetail>>,
    pub audio: Option<Vec<String>>,
    pub local_audio: Vec<PathBuf>,
    pub text_elements: Vec<TextElement>,
}

Fields

client_id: Option<String>

message: String

images: Option<Vec<String>>

Image URLs sourced from UserInput::Image. These are safe to replay in legacy UI history events and correspond to images sent to the model.

image_details: Vec<Option<ImageDetail>>

Detail hints for images, indexed in parallel. Missing entries imply default image detail behavior.

local_images: Vec<PathBuf>

Local file paths sourced from UserInput::LocalImage. These are kept so the UI can reattach images when editing history. Local image prompts may include a display form of the path, but these should not be treated as API-ready URLs.

local_image_details: Vec<Option<ImageDetail>>

Detail hints for local_images, indexed in parallel. Missing entries imply default image detail behavior.

audio: Option<Vec<String>>

Audio URLs sourced from UserInput::Audio. These are safe to replay in legacy UI history events and correspond to audio sent to the model.

local_audio: Vec<PathBuf>

Local file paths sourced from UserInput::LocalAudio. These are kept so clients can reattach audio when editing history and should not be treated as API-ready URLs.

text_elements: Vec<TextElement>

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

Trait Implementations

impl Clone for UserMessageEvent

fn clone(&self) -> UserMessageEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserMessageEvent

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

Formats the value using the given formatter.

impl Default for UserMessageEvent

fn default() -> UserMessageEvent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UserMessageEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for UserMessageEvent

fn schema_name() -> String

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 is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for UserMessageEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for UserMessageEvent

type WithoutGenerics = UserMessageEvent

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = UserMessageEvent

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.