Struct NodeRemote
pub struct NodeRemote<R>where
R: Ratchet,{ /* private fields */ }Expand description
allows convenient communication with the server
Implementations§
§impl<R> NodeRemote<R>where
R: Ratchet,
impl<R> NodeRemote<R>where
R: Ratchet,
pub async fn send_with_custom_ticket(
&self,
ticket: Ticket,
request: NodeRequest,
) -> Result<(), NetworkError>
pub async fn send_with_custom_ticket( &self, ticket: Ticket, request: NodeRequest, ) -> Result<(), NetworkError>
Sends a request to the server with a custom ticket.
pub async fn send(&self, request: NodeRequest) -> Result<Ticket, NetworkError>
pub async fn send(&self, request: NodeRequest) -> Result<Ticket, NetworkError>
Sends a request to the server and returns a ticket for tracking the response.
pub async fn send_callback_subscription(
&self,
request: NodeRequest,
) -> Result<KernelStreamSubscription<R>, NetworkError>
pub async fn send_callback_subscription( &self, request: NodeRequest, ) -> Result<KernelStreamSubscription<R>, NetworkError>
Convenience method for sending and awaiting for a response for the related ticket
pub async fn shutdown(&self) -> Result<(), NetworkError>
pub async fn shutdown(&self) -> Result<(), NetworkError>
Safely shutsdown the internal server
pub fn get_next_ticket(&self) -> Ticket
pub fn try_send_with_custom_ticket( &self, ticket: Ticket, request: NodeRequest, ) -> Result<(), TrySendError<(NodeRequest, Ticket)>>
pub fn try_send( &self, request: NodeRequest, ) -> Result<(), TrySendError<(NodeRequest, Ticket)>>
pub fn local_node_type(&self) -> &NodeType
pub fn account_manager(&self) -> &AccountManager<R, R>
Trait Implementations§
§impl<R> Clone for NodeRemote<R>
impl<R> Clone for NodeRemote<R>
§fn clone(&self) -> NodeRemote<R>
fn clone(&self) -> NodeRemote<R>
Returns a copy of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read more§impl<R> Debug for NodeRemote<R>where
R: Ratchet,
impl<R> Debug for NodeRemote<R>where
R: Ratchet,
Source§impl<R: Ratchet> ProtocolRemoteExt<R> for NodeRemote<R>
impl<R: Ratchet> ProtocolRemoteExt<R> for NodeRemote<R>
Source§fn register<'life0, 'async_trait, T, P, V, K>(
&'life0 self,
addr: T,
full_name: P,
username: V,
proposed_password: K,
default_security_settings: SessionSecuritySettings,
server_password: Option<PreSharedKey>,
) -> Pin<Box<dyn Future<Output = Result<RegisterSuccess, NetworkError>> + Send + 'async_trait>>
fn register<'life0, 'async_trait, T, P, V, K>( &'life0 self, addr: T, full_name: P, username: V, proposed_password: K, default_security_settings: SessionSecuritySettings, server_password: Option<PreSharedKey>, ) -> Pin<Box<dyn Future<Output = Result<RegisterSuccess, NetworkError>> + Send + 'async_trait>>
Registers with custom settings
Returns a ticket which is used to uniquely identify the request in the protocol
Source§fn register_with_defaults<'life0, 'async_trait, T, P, V, K>(
&'life0 self,
addr: T,
full_name: P,
username: V,
proposed_password: K,
) -> Pin<Box<dyn Future<Output = Result<RegisterSuccess, NetworkError>> + Send + 'async_trait>>
fn register_with_defaults<'life0, 'async_trait, T, P, V, K>( &'life0 self, addr: T, full_name: P, username: V, proposed_password: K, ) -> Pin<Box<dyn Future<Output = Result<RegisterSuccess, NetworkError>> + Send + 'async_trait>>
Registers using the default settings. The default uses No Google FCM keys and the default session security settings
Returns a ticket which is used to uniquely identify the request in the protocol
Source§fn connect<'life0, 'async_trait>(
&'life0 self,
auth: AuthenticationRequest,
connect_mode: ConnectMode,
udp_mode: UdpMode,
keep_alive_timeout: Option<Duration>,
session_security_settings: SessionSecuritySettings,
server_password: Option<PreSharedKey>,
) -> Pin<Box<dyn Future<Output = Result<CitadelClientServerConnection<R>, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn connect<'life0, 'async_trait>(
&'life0 self,
auth: AuthenticationRequest,
connect_mode: ConnectMode,
udp_mode: UdpMode,
keep_alive_timeout: Option<Duration>,
session_security_settings: SessionSecuritySettings,
server_password: Option<PreSharedKey>,
) -> Pin<Box<dyn Future<Output = Result<CitadelClientServerConnection<R>, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
Connects with custom settings
Returns a ticket which is used to uniquely identify the request in the protocol
Source§fn connect_with_defaults<'life0, 'async_trait>(
&'life0 self,
auth: AuthenticationRequest,
) -> Pin<Box<dyn Future<Output = Result<CitadelClientServerConnection<R>, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn connect_with_defaults<'life0, 'async_trait>(
&'life0 self,
auth: AuthenticationRequest,
) -> Pin<Box<dyn Future<Output = Result<CitadelClientServerConnection<R>, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
Connects with the default settings
If FCM keys were created during the registration phase, then those keys will be used for the session. If new FCM keys need to be used, consider using
Self::connectSource§fn find_target<'life0, 'async_trait, T, P>(
&'life0 self,
local_user: T,
peer: P,
) -> Pin<Box<dyn Future<Output = Result<SymmetricIdentifierHandleRef<'_, R>, NetworkError>> + Send + 'async_trait>>where
T: 'async_trait + Into<UserIdentifier> + Send,
P: 'async_trait + Into<UserIdentifier> + Send,
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn find_target<'life0, 'async_trait, T, P>(
&'life0 self,
local_user: T,
peer: P,
) -> Pin<Box<dyn Future<Output = Result<SymmetricIdentifierHandleRef<'_, R>, NetworkError>> + Send + 'async_trait>>where
T: 'async_trait + Into<UserIdentifier> + Send,
P: 'async_trait + Into<UserIdentifier> + Send,
Self: Sync + 'async_trait,
'life0: 'async_trait,
Creates a valid target identifier used to make protocol requests. Raw user IDs or usernames can be used Read more
Source§fn propose_target<'life0, 'async_trait, T, P>(
&'life0 self,
local_user: T,
peer: P,
) -> Pin<Box<dyn Future<Output = Result<SymmetricIdentifierHandleRef<'_, R>, NetworkError>> + Send + 'async_trait>>where
T: 'async_trait + Into<UserIdentifier> + Send,
P: 'async_trait + Into<UserIdentifier> + Send,
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn propose_target<'life0, 'async_trait, T, P>(
&'life0 self,
local_user: T,
peer: P,
) -> Pin<Box<dyn Future<Output = Result<SymmetricIdentifierHandleRef<'_, R>, NetworkError>> + Send + 'async_trait>>where
T: 'async_trait + Into<UserIdentifier> + Send,
P: 'async_trait + Into<UserIdentifier> + Send,
Self: Sync + 'async_trait,
'life0: 'async_trait,
Creates a proposed target from the valid local user to an unregistered peer in the network. Used when creating registration requests for peers.
Currently only supports LocalGroup <-> LocalGroup peer connections
Source§fn get_local_group_peers<'life0, 'async_trait, T>(
&'life0 self,
local_user: T,
limit: Option<usize>,
) -> Pin<Box<dyn Future<Output = Result<Vec<LocalGroupPeerFullInfo>, NetworkError>> + Send + 'async_trait>>where
T: 'async_trait + Into<UserIdentifier> + Send,
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn get_local_group_peers<'life0, 'async_trait, T>(
&'life0 self,
local_user: T,
limit: Option<usize>,
) -> Pin<Box<dyn Future<Output = Result<Vec<LocalGroupPeerFullInfo>, NetworkError>> + Send + 'async_trait>>where
T: 'async_trait + Into<UserIdentifier> + Send,
Self: Sync + 'async_trait,
'life0: 'async_trait,
Returns a list of local group peers on the network for local_user. May or may not be registered to the user. To get a list of registered users to local_user, run
Self::get_local_group_mutual_peers Read moreSource§fn get_local_group_mutual_peers<'life0, 'async_trait, T>(
&'life0 self,
local_user: T,
) -> Pin<Box<dyn Future<Output = Result<Vec<LocalGroupPeerFullInfo>, NetworkError>> + Send + 'async_trait>>where
T: 'async_trait + Into<UserIdentifier> + Send,
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn get_local_group_mutual_peers<'life0, 'async_trait, T>(
&'life0 self,
local_user: T,
) -> Pin<Box<dyn Future<Output = Result<Vec<LocalGroupPeerFullInfo>, NetworkError>> + Send + 'async_trait>>where
T: 'async_trait + Into<UserIdentifier> + Send,
Self: Sync + 'async_trait,
'life0: 'async_trait,
Returns a list of mutually-registered peers with the local_user
§impl<R> Remote<R> for NodeRemote<R>where
R: Ratchet,
impl<R> Remote<R> for NodeRemote<R>where
R: Ratchet,
§fn send<'life0, 'async_trait>(
&'life0 self,
request: NodeRequest,
) -> Pin<Box<dyn Future<Output = Result<Ticket, NetworkError>> + Send + 'async_trait>>where
'life0: 'async_trait,
NodeRemote<R>: 'async_trait,
fn send<'life0, 'async_trait>(
&'life0 self,
request: NodeRequest,
) -> Pin<Box<dyn Future<Output = Result<Ticket, NetworkError>> + Send + 'async_trait>>where
'life0: 'async_trait,
NodeRemote<R>: 'async_trait,
Sends a request to the server and returns a ticket for tracking the response.
§fn send_with_custom_ticket<'life0, 'async_trait>(
&'life0 self,
ticket: Ticket,
request: NodeRequest,
) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>where
'life0: 'async_trait,
NodeRemote<R>: 'async_trait,
fn send_with_custom_ticket<'life0, 'async_trait>(
&'life0 self,
ticket: Ticket,
request: NodeRequest,
) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>where
'life0: 'async_trait,
NodeRemote<R>: 'async_trait,
Sends a request to the server with a custom ticket.
§fn send_callback_subscription<'life0, 'async_trait>(
&'life0 self,
request: NodeRequest,
) -> Pin<Box<dyn Future<Output = Result<KernelStreamSubscription<R>, NetworkError>> + Send + 'async_trait>>where
'life0: 'async_trait,
NodeRemote<R>: 'async_trait,
fn send_callback_subscription<'life0, 'async_trait>(
&'life0 self,
request: NodeRequest,
) -> Pin<Box<dyn Future<Output = Result<KernelStreamSubscription<R>, NetworkError>> + Send + 'async_trait>>where
'life0: 'async_trait,
NodeRemote<R>: 'async_trait,
Sends a request to the server and returns a subscription for callback events.
§fn account_manager(&self) -> &AccountManager<R, R>
fn account_manager(&self) -> &AccountManager<R, R>
Returns the account manager instance.
§fn get_next_ticket(&self) -> Ticket
fn get_next_ticket(&self) -> Ticket
Returns the next available ticket.
impl<R> Unpin for NodeRemote<R>where
R: Ratchet,
Auto Trait Implementations§
impl<R> Freeze for NodeRemote<R>
impl<R> !RefUnwindSafe for NodeRemote<R>
impl<R> Send for NodeRemote<R>
impl<R> Sync for NodeRemote<R>
impl<R> !UnwindSafe for NodeRemote<R>
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
Formats each item in a sequence. Read more
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self, then passes self.as_mut() into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self, then passes self.deref() into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut() only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow() only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut() only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref() only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut() only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref() only in debug builds, and is erased in release
builds.