Skip to main content

MessageAnnotationsAttachment

Struct MessageAnnotationsAttachment 

Source
pub struct MessageAnnotationsAttachment {
    pub label: String,
    pub range: Option<TextRange>,
    pub display_kind: Option<String>,
    pub meta: Option<JsonObject>,
    pub resource: Uri,
    pub annotation_ids: Option<Vec<String>>,
}
Expand description

An attachment that references annotations on a session’s annotations channel (see {@link AnnotationsState}).

When {@link annotationIds} is omitted the attachment references every annotation on the channel; when present it references only the listed {@link Annotation.id | annotation ids}.

Fields§

§label: String

A human-readable label for the attachment (e.g. the filename of a file attachment). Used for display in UI.

§range: Option<TextRange>

If defined, the range in {@link Message.text} that references this attachment. This is a text range, not a byte range.

§display_kind: Option<String>

Advisory display hint for clients rendering this attachment. Recognized values include:

  • 'image': the attachment is an image
  • 'document': the attachment is a textual document
  • 'symbol': the attachment is a code symbol (e.g. a function or class)
  • 'directory': the attachment is a folder
  • 'selection': the attachment is a selection within a document

Implementations MAY provide additional values; clients SHOULD fall back to a reasonable default when an unknown value is encountered.

§meta: Option<JsonObject>

Additional implementation-defined metadata for the attachment.

If the attachment was produced by the completions command, the client MUST preserve every property of _meta originally returned by the agent host when sending the user message containing the accepted completion.

§resource: Uri

The annotations channel URI (typically ahp-session:/<uuid>/annotations). Matches {@link AnnotationsSummary.resource}.

§annotation_ids: Option<Vec<String>>

Specific {@link Annotation.id | annotation ids} to reference. When omitted, the attachment references all annotations on the channel.

Trait Implementations§

Source§

impl Clone for MessageAnnotationsAttachment

Source§

fn clone(&self) -> MessageAnnotationsAttachment

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 MessageAnnotationsAttachment

Source§

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

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

impl<'de> Deserialize<'de> for MessageAnnotationsAttachment

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 PartialEq for MessageAnnotationsAttachment

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 MessageAnnotationsAttachment

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 MessageAnnotationsAttachment

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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.