Skip to main content

UserContent

Enum UserContent 

Source
pub enum UserContent {
    Text {
        text: String,
    },
    ImageUrl {
        image_url: ImageUrl,
    },
    File {
        file: FileContent,
    },
}
Expand description

User content types supported by OpenRouter.

OpenRouter uses different content type structures than OpenAI’s Chat Completions API, particularly for file/document content. This enum matches OpenRouter’s API specification.

§Supported Content Types

  • Text: Plain text content
  • ImageUrl: Images via URL or base64 data URI
  • File: PDF documents and other files via URL or base64 data URI

§Example

use rig::providers::openrouter::UserContent;

// Text content
let text = UserContent::text("Hello, world!");

// Image from URL
let image = UserContent::image_url("https://example.com/image.png");

// PDF from URL
let pdf = UserContent::file_url("https://example.com/document.pdf", Some("document.pdf".to_string()));

Variants§

§

Text

Plain text content

Fields

§text: String
§

ImageUrl

Image content (URL or base64 data URI)

Supports: image/png, image/jpeg, image/webp, image/gif

Fields

§image_url: ImageUrl
§

File

File content (for PDFs and other documents)

Uses file_data field which accepts either a publicly accessible URL or base64-encoded content as a data URI.

Fields

Implementations§

Source§

impl UserContent

Source

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

Create text content

Source

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

Create image content from URL

Source

pub fn image_url_with_detail( url: impl Into<String>, detail: ImageDetail, ) -> Self

Create image content from URL with detail level

Source

pub fn image_base64( data: impl Into<String>, mime_type: &str, detail: Option<ImageDetail>, ) -> Self

Create image content from base64 data

§Arguments
  • data - Base64-encoded image data
  • mime_type - MIME type (e.g., “image/png”, “image/jpeg”)
  • detail - Optional detail level for image processing
Source

pub fn file_url(url: impl Into<String>, filename: Option<String>) -> Self

Create file content from URL

§Arguments
  • url - URL to the file (must be publicly accessible)
  • filename - Optional filename for the document
Source

pub fn file_base64( data: impl Into<String>, mime_type: &str, filename: Option<String>, ) -> Self

Create file content from base64 data

§Arguments
  • data - Base64-encoded file data
  • mime_type - MIME type (e.g., “application/pdf”)
  • filename - Optional filename for the document

Trait Implementations§

Source§

impl Clone for UserContent

Source§

fn clone(&self) -> UserContent

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UserContent

Source§

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

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

impl<'de> Deserialize<'de> for UserContent

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 From<&str> for UserContent

Source§

fn from(text: &str) -> Self

Converts to this type from the input type.
Source§

impl From<String> for UserContent

Source§

fn from(text: String) -> Self

Converts to this type from the input type.
Source§

impl From<UserContent> for UserContent

Convert OpenAI’s UserContent to OpenRouter’s UserContent

Source§

fn from(value: UserContent) -> Self

Converts to this type from the input type.
Source§

impl FromStr for UserContent

Source§

type Err = Infallible

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl PartialEq for UserContent

Source§

fn eq(&self, other: &UserContent) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for UserContent

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

impl TryFrom<UserContent> for UserContent

Source§

type Error = MessageError

The type returned in the event of a conversion error.
Source§

fn try_from(value: UserContent) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl StructuralPartialEq for UserContent

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> ArgumentConvert for T
where T: FromStr,

Source§

type Err = <T as FromStr>::Err

The associated error which can be returned from parsing.
Source§

fn convert<'life0, 'async_trait>( __arg0: impl CacheHttp + 'async_trait, __arg1: Option<GuildId>, __arg2: Option<ChannelId>, s: &'life0 str, ) -> Pin<Box<dyn Future<Output = Result<T, <T as ArgumentConvert>::Err>> + Send + 'async_trait>>
where 'life0: 'async_trait, T: 'async_trait,

Parses a string s as a command parameter of this type.
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> CloneDebuggableStorage for T

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> CloneableStorage for T
where T: Any + Send + Sync + Clone,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

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

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

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DebuggableStorage for T
where T: Any + Send + Sync + Debug,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,