Struct ProviderDefinition 

pub struct ProviderDefinition {
    pub descriptor: ProviderDescriptor,
    pub wire_api: WireApi,
    pub auth_scheme: AuthScheme,
    pub capabilities: ProviderCapabilities,
    pub base_url: Option<String>,
    pub query_params: Option<HashMap<String, String>>,
    pub headers: Option<HashMap<String, String>>,
    pub retry: RetryPolicy,
    pub stream_idle_timeout: Duration,
    pub websocket_connect_timeout: Duration,
}

Serializable provider definition used by runtime and adapter layers.

Fields

descriptor: ProviderDescriptor

wire_api: WireApi

auth_scheme: AuthScheme

capabilities: ProviderCapabilities

base_url: Option<String>

query_params: Option<HashMap<String, String>>

headers: Option<HashMap<String, String>>

retry: RetryPolicy

stream_idle_timeout: Duration

websocket_connect_timeout: Duration

Implementations

impl ProviderDefinition

pub fn new(id: impl Into<ProviderId>) -> ProviderDefinition

pub fn descriptor(&self) -> ProviderDescriptor

pub fn provider_id(&self) -> &ProviderId

pub fn url_for_path(&self, path: &str) -> String

pub fn build_headers( &self, credentials: &ProviderCredentials, ) -> Result<HeaderMap, ProviderError>

pub fn build_headers_for_session( &self, credentials: &ProviderCredentials, session: Option<&SessionRequestOptions>, fallback_turn_state: Option<&str>, ) -> Result<HeaderMap, ProviderError>

pub fn request_url_with_auth_for_path( &self, path: &str, credentials: &ProviderCredentials, ) -> Result<Url, ProviderError>

pub fn websocket_url_for_path(&self, path: &str) -> Result<Url, ParseError>

pub fn websocket_url_with_auth_for_path( &self, path: &str, credentials: &ProviderCredentials, ) -> Result<Url, ProviderError>

Trait Implementations

impl Clone for ProviderDefinition

fn clone(&self) -> ProviderDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProviderDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProviderDefinition

fn deserialize<__D>( __deserializer: __D, ) -> Result<ProviderDefinition, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ProviderDefinition

fn eq(&self, other: &ProviderDefinition) -> 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 ProviderDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ProviderDefinition

impl StructuralPartialEq for ProviderDefinition