Struct AdditionalHeaders

pub struct AdditionalHeaders { /* private fields */ }

This is the only interface to set/get runtime level headers when sending requests to endpoints such as OpenAI.

Usage

1. Call AdditionalHeaders::default() to initialize an instance.
2. Call set_header() to set required headers.
3. Depends on the caller:

• If you are using Rust-AI as an library, call to_var() to set related environment variable.
• If you are calling from Rust-AI itself, you should call provide() to turn current instance into HeaderMap.

Implementations

impl AdditionalHeaders

pub fn from_var() -> Self

Try to initialize AdditionalHeaders instance from environment variable. If no such environment variables available, then create an empty instance.

impl AdditionalHeaders

pub fn set_header<'a>(&mut self, header: (&'a str, &'a str))

Set a new header pair. Header name and values should never include NUL characters (\0).

pub fn provide(&self) -> HeaderMap

Turn the contained headers into HeaderMap. Will not consume current instance.

pub fn to_var(&self)

Try to serialize current instance into string form and set to specific environment variable.

Trait Implementations

impl Debug for AdditionalHeaders

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

Formats the value using the given formatter.

impl Default for AdditionalHeaders

fn default() -> Self

Create a new instance of AdditionalHeaders that doesn’t contain any headers.

impl<'de> Deserialize<'de> for AdditionalHeaders

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AdditionalHeaders

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

where __S: Serializer,

Serialize this value into the given Serde serializer.