Skip to main content

ChatMessage

gpui_ai::chat

Struct ChatMessage 

Source 
pub struct ChatMessage { /* private fields */ }
Expand description

One application-owned message snapshot rendered by Chat.

IDs must be unique within a controlled snapshot. The message keeps all progressive content and interaction metadata immutable; applications replace the enclosing Arc<[ChatMessage]> as work advances.

Implementations§

Source§

impl ChatMessage

Source

pub fn new( id: impl Into<SharedString>, role: ChatRole, content: StreamedContent, ) -> Self

Creates a message with stable application identity and progressive text.

Source

pub fn actions(self, actions: MessageActions) -> Self

Overrides the actions this message offers (default: MessageActions::for_role).

Source

pub fn message_actions(&self) -> MessageActions

The actions this message offers.

Source

pub fn with_appearance(self, appearance: ChatMessageAppearance) -> Self

Sets this message’s presentation (alignment and bubble treatment).

Source

pub fn appearance(&self) -> &ChatMessageAppearance

This message’s presentation.

Source

pub fn author(self, author: impl Into<SharedString>) -> Self

Adds an optional visible author name.

Source

pub fn citations(self, citations: impl IntoIterator<Item = CitationRef>) -> Self

Adds application-owned inline citation metadata.

Source

pub fn sources( self, sources: impl IntoIterator<Item = impl Into<SharedString>>, ) -> Self

Adds source labels shown after progressive content settles.

Source

pub fn follow_ups(self, follow_ups: impl IntoIterator<Item = FollowUp>) -> Self

Adds stable follow-up suggestions.

Source

pub fn attachments( self, attachments: impl IntoIterator<Item = Attachment>, ) -> Self

Attaches files shown read-only above the content; activating one reports ChatEvent::AttachmentActivated.

Source

pub fn branch(self, position: BranchPosition) -> Self

Marks this message as one of several versions; the header shows a switcher that reports ChatEvent::BranchSelected.

Source

pub fn retryable(self, retryable: bool) -> Self

Controls whether a failed message exposes a retry action.

Source

pub fn id(&self) -> &SharedString

Returns the stable application-level message identifier.

Source

pub fn role(&self) -> ChatRole

Returns the message role.

Source

pub fn author_name(&self) -> Option<&SharedString>

Returns the optional visible author.

Source

pub fn content(&self) -> &StreamedContent

Returns the progressive content snapshot.

Source

pub fn citation_refs(&self) -> &[CitationRef]

Returns inline citation metadata.

Source

pub fn source_labels(&self) -> &[SharedString]

Returns source labels.

Source

pub fn follow_up_suggestions(&self) -> &[FollowUp]

Returns follow-up suggestions.

Source

pub fn attachment_refs(&self) -> &[Attachment]

Returns the attachments carried by this message.

Source

pub fn branch_position(&self) -> Option<BranchPosition>

Returns where this message sits among its versions, if branched.

Source

pub fn is_retryable(&self) -> bool

Returns whether a failed message may be retried.

Trait Implementations§

Source§

impl Clone for ChatMessage

Source§

fn clone(&self) -> ChatMessage

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 ChatMessage

Source§

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

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

impl Eq for ChatMessage

Source§

impl PartialEq for ChatMessage

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ChatMessage

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DynClone for T
where T: Clone,

Source§

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

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper.
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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer.
§

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

Dereferences the given pointer.
§

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

Mutably dereferences the given pointer.
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer.
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper.