Struct CopilotConfig 

pub struct CopilotConfig {
    pub api_key: Secret,
    pub base_url: String,
}

Copilot’s configuration: plain data, credential redacted.

The credential is an exchanged Copilot session token, not a GitHub OAuth token: see the module docs and Self::from_auth.

Fields

api_key: Secret

The exchanged session token. Never serialized (see Secret).

base_url: String

The API root every path resolves against.

Implementations

impl CopilotConfig

pub fn connect(self, http: impl HttpClientExt + 'static) -> Copilot

A client that sends this configuration’s requests through http.

pub fn client(self) -> Copilot

Available on crate feature reqwest only.

A client that sends through the shared reqwest client (rig_reqwest::shared()), built once per process.

impl CopilotConfig

pub fn new(api_key: impl Into<Secret>) -> Self

Configure Copilot with an exchanged session token. Derive a permitted endpoint from proxy-ep= when present, otherwise use the default. Explicit base-URL settings override token-derived routing.

pub fn from_auth(context: &AuthContext) -> Self

Configure Copilot from an exchanged auth context. The context’s API base takes precedence over token-derived routing.

pub fn from_env() -> Result<Self, EnvError>

Read an exchanged token from GITHUB_COPILOT_API_KEY or COPILOT_API_KEY. Read the optional base URL from GITHUB_COPILOT_API_BASE or COPILOT_BASE_URL. Earlier nonblank variables take precedence. Return an error for missing credentials or invalid environment values; this does not perform token exchange.

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

Override the base URL.

Trait Implementations

impl Clone for CopilotConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CopilotConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CopilotConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CopilotConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CopilotConfig

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 CopilotConfig