Struct GitHubCopilotChatClient 

pub struct GitHubCopilotChatClient { /* private fields */ }

A GitHub Copilot chat client (POST {base_url}/chat/completions).

Implementations

impl GitHubCopilotChatClient

pub fn new(github_token: impl Into<String>, model: impl Into<String>) -> Self

Create a client for the given GitHub OAuth token / PAT and default model, targeting the default Copilot API base URL.

github_token is not sent directly to the chat endpoint — it is exchanged for a short-lived Copilot API token on first use (see the crate-level docs).

pub fn from_env(model: impl Into<String>) -> Result<Self>

Build a client from the environment: the GitHub OAuth token / PAT is read from GITHUB_TOKEN_ENV (GITHUB_COPILOT_TOKEN), falling back to GITHUB_TOKEN_ENV_ALT (GH_COPILOT_TOKEN) if unset; an Error::Configuration is returned if neither is set. The optional BASE_URL_ENV (GITHUB_COPILOT_BASE_URL) overrides the default base URL when present.

pub fn with_base_url(self, base_url: impl Into<String>) -> Self

Override the base URL (e.g. for an enterprise deployment or a proxy in front of the Copilot API).

pub fn model(&self) -> &str

The default model id.

pub fn base_url(&self) -> &str

The configured base URL.

Trait Implementations

impl ChatClient for GitHubCopilotChatClient

fn get_response<'life0, 'async_trait>( &'life0 self, messages: Vec<Message>, options: ChatOptions, ) -> Pin<Box<dyn Future<Output = Result<ChatResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get a complete (non-streaming) response.

fn get_streaming_response<'life0, 'async_trait>( &'life0 self, messages: Vec<Message>, options: ChatOptions, ) -> Pin<Box<dyn Future<Output = Result<ChatStream>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get a streaming response as a sequence of updates.

fn model(&self) -> Option<&str>

The default model id for this client, if any.

impl Clone for GitHubCopilotChatClient

fn clone(&self) -> GitHubCopilotChatClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitHubCopilotChatClient

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

Formats the value using the given formatter.