Skip to main content

RealtimeRoute

Enum RealtimeRoute 

Source
pub enum RealtimeRoute<'a> {
    CreateCall,
    CreateLiveCall,
    Connect,
    Live {
        call_id: Option<&'a str>,
    },
    HangupCall {
        call_id: &'a str,
    },
    CreateLiveSession,
    LiveSession {
        session_id: Option<&'a str>,
    },
    HangupLiveSession {
        session_id: &'a str,
    },
}
Expand description

HTTP/WS entry paths for the OpenAI realtime family. The host still owns authentication, model routing and upgrading the connection.

Variants§

§

CreateCall

§

CreateLiveCall

§

Connect

§

Live

Fields

§call_id: Option<&'a str>
§

HangupCall

Fields

§call_id: &'a str
§

CreateLiveSession

§

LiveSession

Fields

§session_id: Option<&'a str>
§

HangupLiveSession

Fields

§session_id: &'a str

Implementations§

Source§

impl<'a> RealtimeRoute<'a>

Source

pub fn from_request(method: &Method, path: &'a str) -> Option<Self>

/live serves HTTP setup and a WebSocket; the method disambiguates it.

Source

pub fn from_path(path: &'a str) -> Option<Self>

Match native paths, with or without the public /v1 mount. Path call IDs remain percent-encoded so adapters can preserve them.

Source

pub fn operation(self) -> OperationKey

Trait Implementations§

Source§

impl<'a> Clone for RealtimeRoute<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for RealtimeRoute<'a>

Source§

impl<'a> Debug for RealtimeRoute<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Eq for RealtimeRoute<'a>

Source§

impl<'a> PartialEq for RealtimeRoute<'a>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for RealtimeRoute<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for RealtimeRoute<'a>

§

impl<'a> RefUnwindSafe for RealtimeRoute<'a>

§

impl<'a> Send for RealtimeRoute<'a>

§

impl<'a> Sync for RealtimeRoute<'a>

§

impl<'a> Unpin for RealtimeRoute<'a>

§

impl<'a> UnsafeUnpin for RealtimeRoute<'a>

§

impl<'a> UnwindSafe for RealtimeRoute<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ResourceSend for T
where T: Send + ?Sized,

Source§

impl<T> ResourceSync for T
where T: Sync + ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.