Struct citadel_sdk::prelude::NodeRemote
pub struct NodeRemote { /* private fields */ }
Expand description
allows convenient communication with the server
Implementations§
§impl NodeRemote
impl NodeRemote
pub async fn send_with_custom_ticket(
&self,
ticket: Ticket,
request: NodeRequest
) -> impl Future<Output = Result<(), NetworkError>>
pub async fn send_with_custom_ticket( &self, ticket: Ticket, request: NodeRequest ) -> impl Future<Output = Result<(), NetworkError>>
Especially used to keep track of a conversation (b/c a certain ticket number may be expected)
pub async fn send(
&self,
request: NodeRequest
) -> impl Future<Output = Result<Ticket, NetworkError>>
pub async fn send( &self, request: NodeRequest ) -> impl Future<Output = Result<Ticket, NetworkError>>
Sends a request to the HDP server. This should always be used to communicate with the server in order to obtain a ticket
pub async fn send_callback_custom_ticket(
&self,
request: NodeRequest,
ticket: Ticket
) -> impl Future<Output = Result<NodeResult, NetworkError>>
pub async fn send_callback_custom_ticket( &self, request: NodeRequest, ticket: Ticket ) -> impl Future<Output = Result<NodeResult, NetworkError>>
Returns an error if the ticket is already registered for a callback
pub async fn send_callback_subscription(
&self,
request: NodeRequest
) -> impl Future<Output = Result<KernelStreamSubscription, NetworkError>>
pub async fn send_callback_subscription( &self, request: NodeRequest ) -> impl Future<Output = Result<KernelStreamSubscription, NetworkError>>
Convenience method for sending and awaiting for a response for the related ticket
pub async fn send_callback(
&self,
request: NodeRequest
) -> impl Future<Output = Result<NodeResult, NetworkError>>
pub async fn send_callback( &self, request: NodeRequest ) -> impl Future<Output = Result<NodeResult, NetworkError>>
Convenience method for sending and awaiting for a response for the related ticket
pub async fn send_callback_timeout(
&self,
request: NodeRequest,
timeout: Duration
) -> impl Future<Output = Result<NodeResult, NetworkError>>
pub async fn send_callback_timeout( &self, request: NodeRequest, timeout: Duration ) -> impl Future<Output = Result<NodeResult, NetworkError>>
Convenience method for sending and awaiting for a response for the related ticket (with a timeout)
pub async fn shutdown(&self) -> impl Future<Output = Result<(), NetworkError>>
pub async fn shutdown(&self) -> impl Future<Output = 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<StackedRatchet, ThinRatchet>
Trait Implementations§
§impl Clone for NodeRemote
impl Clone for NodeRemote
§fn clone(&self) -> NodeRemote
fn clone(&self) -> NodeRemote
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 Debug for NodeRemote
impl Debug for NodeRemote
source§impl ProtocolRemoteExt for NodeRemote
impl ProtocolRemoteExt for NodeRemote
source§fn register<'life0, 'async_trait, T, R, V, K>(
&'life0 self,
addr: T,
full_name: R,
username: V,
proposed_password: K,
default_security_settings: SessionSecuritySettings
) -> Pin<Box<dyn Future<Output = Result<RegisterSuccess, NetworkError>> + Send + 'async_trait>>where
T: 'async_trait + ToSocketAddrs + Send,
R: 'async_trait + Into<String> + Send,
V: 'async_trait + Into<String> + Send,
K: 'async_trait + Into<SecBuffer> + Send,
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn register<'life0, 'async_trait, T, R, V, K>( &'life0 self, addr: T, full_name: R, username: V, proposed_password: K, default_security_settings: SessionSecuritySettings ) -> Pin<Box<dyn Future<Output = Result<RegisterSuccess, NetworkError>> + Send + 'async_trait>>where T: 'async_trait + ToSocketAddrs + Send, R: 'async_trait + Into<String> + Send, V: 'async_trait + Into<String> + Send, K: 'async_trait + Into<SecBuffer> + Send, Self: Sync + 'async_trait, 'life0: '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, R, V, K>(
&'life0 self,
addr: T,
full_name: R,
username: V,
proposed_password: K
) -> Pin<Box<dyn Future<Output = Result<RegisterSuccess, NetworkError>> + Send + 'async_trait>>where
T: 'async_trait + ToSocketAddrs + Send,
R: 'async_trait + Into<String> + Send,
V: 'async_trait + Into<String> + Send,
K: 'async_trait + Into<SecBuffer> + Send,
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn register_with_defaults<'life0, 'async_trait, T, R, V, K>( &'life0 self, addr: T, full_name: R, username: V, proposed_password: K ) -> Pin<Box<dyn Future<Output = Result<RegisterSuccess, NetworkError>> + Send + 'async_trait>>where T: 'async_trait + ToSocketAddrs + Send, R: 'async_trait + Into<String> + Send, V: 'async_trait + Into<String> + Send, K: 'async_trait + Into<SecBuffer> + Send, Self: Sync + 'async_trait, 'life0: '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
) -> Pin<Box<dyn Future<Output = Result<ConnectionSuccess, 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 ) -> Pin<Box<dyn Future<Output = Result<ConnectionSuccess, 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<ConnectionSuccess, 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<ConnectionSuccess, 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::connect
source§fn find_target<'life0, 'async_trait, T, R>(
&'life0 self,
local_user: T,
peer: R
) -> Pin<Box<dyn Future<Output = Result<SymmetricIdentifierHandleRef<'_>, NetworkError>> + Send + 'async_trait>>where
T: 'async_trait + Into<UserIdentifier> + Send,
R: 'async_trait + Into<UserIdentifier> + Send,
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn find_target<'life0, 'async_trait, T, R>( &'life0 self, local_user: T, peer: R ) -> Pin<Box<dyn Future<Output = Result<SymmetricIdentifierHandleRef<'_>, NetworkError>> + Send + 'async_trait>>where T: 'async_trait + Into<UserIdentifier> + Send, R: '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<'_>, 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<'_>, 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<LocalGroupPeer>, 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<LocalGroupPeer>, 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<LocalGroupPeer>, 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<LocalGroupPeer>, 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 Remote for NodeRemote
impl Remote for NodeRemote
fn send<'life0, 'async_trait>( &'life0 self, request: NodeRequest ) -> Pin<Box<dyn Future<Output = Result<Ticket, NetworkError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, NodeRemote: '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, Global>>where 'life0: 'async_trait, NodeRemote: 'async_trait,
fn send_callback_subscription<'life0, 'async_trait>( &'life0 self, request: NodeRequest ) -> Pin<Box<dyn Future<Output = Result<KernelStreamSubscription, NetworkError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, NodeRemote: 'async_trait,
fn send_callback<'life0, 'async_trait>( &'life0 self, request: NodeRequest ) -> Pin<Box<dyn Future<Output = Result<NodeResult, NetworkError>> + Send + 'async_trait, Global>>where 'life0: 'async_trait, NodeRemote: 'async_trait,
fn account_manager(&self) -> &AccountManager<StackedRatchet, ThinRatchet>
fn get_next_ticket(&self) -> Ticket
impl Unpin for NodeRemote
Auto Trait Implementations§
impl !RefUnwindSafe for NodeRemote
impl Send for NodeRemote
impl Sync for NodeRemote
impl !UnwindSafe for NodeRemote
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
§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>
§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) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere Self: Borrow<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> Rwhere Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere Self: AsRef<U>, U: 'a + ?Sized, R: 'a,
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) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere Self: AsMut<U>, U: 'a + ?Sized, R: 'a,
Mutably borrows
self
, then passes self.as_mut()
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)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
Immutable access to the
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
Mutable access to the
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
Immutable access to the
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
Mutable access to the
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere Self: Deref<Target = T>, T: ?Sized,
Immutable access to the
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere Self: DerefMut<Target = T> + Deref, T: ?Sized,
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)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere Self: Borrow<B>, B: ?Sized,
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)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere Self: BorrowMut<B>, B: ?Sized,
Calls
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere Self: AsRef<R>, R: ?Sized,
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)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere Self: AsMut<R>, R: ?Sized,
Calls
.tap_ref_mut()
only in debug builds, and is erased in release
builds.