pub struct RealtimeClient { /* private fields */ }Expand description
Stateful realtime connection for issuing Inline RPC calls.
Implementations§
Source§impl RealtimeClient
impl RealtimeClient
Sourcepub fn builder(
url: impl Into<String>,
token: impl Into<String>,
) -> RealtimeClientBuilder
pub fn builder( url: impl Into<String>, token: impl Into<String>, ) -> RealtimeClientBuilder
Starts a realtime client builder.
Sourcepub async fn connect(url: &str, token: &str) -> Result<Self, RealtimeError>
pub async fn connect(url: &str, token: &str) -> Result<Self, RealtimeError>
Connects to realtime using the default SDK identity.
Sourcepub async fn connect_with_identity(
url: &str,
token: &str,
identity: ClientIdentity,
) -> Result<Self, RealtimeError>
pub async fn connect_with_identity( url: &str, token: &str, identity: ClientIdentity, ) -> Result<Self, RealtimeError>
Connects to realtime using a caller-provided client identity.
Source§impl RealtimeClient
impl RealtimeClient
Sourcepub async fn call<R>(
&mut self,
request: R,
) -> Result<R::Response, RealtimeError>where
R: RpcRequest,
pub async fn call<R>(
&mut self,
request: R,
) -> Result<R::Response, RealtimeError>where
R: RpcRequest,
Invokes a typed Inline RPC request.
Sourcepub async fn invoke(
&mut self,
method: Method,
input: Input,
) -> Result<Result, RealtimeError>
pub async fn invoke( &mut self, method: Method, input: Input, ) -> Result<Result, RealtimeError>
Invokes an Inline RPC method and waits for the matching result.
Sourcepub fn rpc_timeout(&self) -> Option<Duration>
pub fn rpc_timeout(&self) -> Option<Duration>
Returns the configured per-RPC timeout.
Auto Trait Implementations§
impl !Freeze for RealtimeClient
impl !RefUnwindSafe for RealtimeClient
impl !UnwindSafe for RealtimeClient
impl Send for RealtimeClient
impl Sync for RealtimeClient
impl Unpin for RealtimeClient
impl UnsafeUnpin for RealtimeClient
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more