Enum Attachment 

#[non_exhaustive]
pub enum Attachment {
    File {
        path: PathBuf,
        display_name: Option<String>,
        line_range: Option<AttachmentLineRange>,
    },
    Directory {
        path: PathBuf,
        display_name: Option<String>,
    },
    Selection {
        file_path: PathBuf,
        text: String,
        display_name: Option<String>,
        selection: AttachmentSelectionRange,
    },
    Blob {
        data: String,
        mime_type: String,
        display_name: Option<String>,
    },
    GitHubReference {
        number: u64,
        title: String,
        reference_type: GitHubReferenceType,
        state: String,
        url: String,
    },
}

An attachment included with a user message.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

File

A file path, optionally with a line range.

Fields

path: PathBuf

Absolute path to the file.

display_name: Option<String>

Label shown in the UI.

line_range: Option<AttachmentLineRange>

Optional line range to focus on.

Directory

A directory path.

Fields

path: PathBuf

Absolute path to the directory.

display_name: Option<String>

Label shown in the UI.

Selection

A text selection within a file.

Fields

file_path: PathBuf

Path to the file containing the selection.

text: String

The selected text content.

display_name: Option<String>

Label shown in the UI.

selection: AttachmentSelectionRange

Character range of the selection.

Blob

Raw binary data (e.g. an image).

Fields

data: String

Base64-encoded data.

mime_type: String

MIME type of the data.

display_name: Option<String>

Label shown in the UI.

GitHubReference

A reference to a GitHub issue, PR, or discussion.

Fields

number: u64

Issue/PR/discussion number.

title: String

Title of the referenced item.

reference_type: GitHubReferenceType

Kind of reference.

state: String

Current state (e.g. “open”, “closed”).

url: String

URL to the referenced item.

Implementations

impl Attachment

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

Returns the display name, if set.

pub fn label(&self) -> Option<String>

Returns a human-readable label, deriving one from the path if needed.

pub fn ensure_display_name(&mut self)

Ensure display_name is populated when the variant supports one.

Trait Implementations

impl Clone for Attachment

fn clone(&self) -> Attachment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Attachment

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Attachment

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Attachment

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Attachment

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Attachment

impl StructuralPartialEq for Attachment