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,
    },
    GitHubCommit {
        message: String,
        oid: String,
        repo: GitHubRepoPointer,
        url: String,
    },
    GitHubRelease {
        name: String,
        repo: GitHubRepoPointer,
        tag_name: String,
        url: String,
    },
    GitHubActionsJob {
        conclusion: Option<String>,
        job_id: i64,
        job_name: String,
        repo: GitHubRepoPointer,
        url: String,
        workflow_name: String,
    },
    GitHubRepository {
        description: Option<String>,
        ref: Option<String>,
        repo: GitHubRepoPointer,
        url: String,
    },
    GitHubFileDiff {
        base: Option<GitHubFileDiffSide>,
        head: Option<GitHubFileDiffSide>,
        url: String,
    },
    GitHubTreeComparison {
        base: GitHubTreeComparisonSide,
        head: GitHubTreeComparisonSide,
        url: String,
    },
    GitHubUrl {
        url: String,
    },
    GitHubFile {
        path: String,
        ref: String,
        repo: GitHubRepoPointer,
        url: String,
    },
    GitHubSnippet {
        line_range: GitHubSnippetLineRange,
        path: String,
        ref: String,
        repo: GitHubRepoPointer,
        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.

GitHubCommit

A pointer to a GitHub commit.

Fields

message: String

First line of the commit message.

oid: String

Full commit SHA.

repo: GitHubRepoPointer

Repository the commit belongs to.

url: String

URL to the commit on GitHub.

GitHubRelease

A pointer to a GitHub release.

Fields

name: String

Human-readable release name.

repo: GitHubRepoPointer

Repository the release belongs to.

tag_name: String

Git tag the release is anchored to.

url: String

URL to the release on GitHub.

GitHubActionsJob

A pointer to a GitHub Actions job.

Fields

conclusion: Option<String>

Terminal conclusion of the job when finished (e.g. “success”, “failure”, “cancelled”). Absent for in-progress jobs.

job_id: i64

Job id within the workflow run.

job_name: String

Display name of the job.

repo: GitHubRepoPointer

Repository the workflow run belongs to.

url: String

URL to the job on GitHub.

workflow_name: String

Display name of the workflow the job ran in.

GitHubRepository

A pointer to a GitHub repository.

Fields

description: Option<String>

Short description of the repository.

ref: Option<String>

Git ref this attachment is anchored at (branch, tag, or commit). When absent the default branch is implied.

repo: GitHubRepoPointer

Repository pointer.

url: String

URL to the repository on GitHub.

GitHubFileDiff

A pointer to a single-file diff. At least one of head and base is present.

Fields

base: Option<GitHubFileDiffSide>

File location on the base side of the diff. Absent for additions.

head: Option<GitHubFileDiffSide>

File location on the head side of the diff. Absent for deletions.

url: String

URL to the diff on GitHub (e.g. a commit, compare, or PR-file URL).

GitHubTreeComparison

A pointer to a comparison between two git revisions.

Fields

base: GitHubTreeComparisonSide

Base side of the comparison.

head: GitHubTreeComparisonSide

Head side of the comparison.

url: String

URL to the comparison on GitHub.

GitHubUrl

A generic GitHub URL reference.

Fields

url: String

URL to the GitHub resource.

GitHubFile

A pointer to a file in a GitHub repository at a specific ref.

Fields

path: String

Repository-relative path to the file.

ref: String

Git ref the file is read at (branch, tag, or commit SHA).

repo: GitHubRepoPointer

Repository the file lives in.

url: String

URL to the file on GitHub.

GitHubSnippet

A pointer to a line range inside a file in a GitHub repository.

Fields

line_range: GitHubSnippetLineRange

Line range the snippet covers.

path: String

Repository-relative path to the file.

ref: String

Git ref the file is read at (branch, tag, or commit SHA).

repo: GitHubRepoPointer

Repository the file lives in.

url: String

URL to the snippet on GitHub (with line anchor).

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 Eq for Attachment

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 StructuralPartialEq for Attachment