Skip to main content

UserContent

Enum UserContent 

Source
pub enum UserContent {
    Text(TextBlock),
    Image(ImageBlock),
}
Expand description

Content that can be sent as part of a user turn.

This is the primary type callers use to build messages.

Variants§

§

Text(TextBlock)

A plain text message.

§

Image(ImageBlock)

An image (base64 or URL).

Implementations§

Source§

impl UserContent

Source

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

Construct a plain-text UserContent from any string-like value.

§Example
use claude_cli_sdk::types::content::UserContent;
let msg = UserContent::text("Hello, Claude!");
Source

pub fn image_base64( data: impl Into<String>, media_type: impl Into<String>, ) -> Result<Self>

Construct a base64-encoded image UserContent, validating the MIME type and payload size.

§Errors

Returns Error::ImageValidation if:

  • media_type is not one of image/jpeg, image/png, image/gif, image/webp.
  • data (the base64 string) exceeds 15 MiB.
§Example
use claude_cli_sdk::types::content::UserContent;

let content = UserContent::image_base64("aGVsbG8=", "image/png").unwrap();
Source

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

Construct a URL-referenced image UserContent, validating the MIME type hint when provided.

§Errors

Returns Error::ImageValidation if media_type is Some but not in the allowed MIME type list.

§Example
use claude_cli_sdk::types::content::UserContent;

let content = UserContent::image_url("https://example.com/img.png", "image/png").unwrap();
Source

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

Construct a URL-referenced image without a MIME type hint.

Source

pub fn as_text(&self) -> Option<&str>

Returns the text string if this is a UserContent::Text variant.

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(s: &str) -> Self

Converts to this type from the input type.
Source§

impl From<String> for UserContent

Source§

fn from(s: String) -> Self

Converts to this type from the input type.
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 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> 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.

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> 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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,