Struct citadel_sdk::prelude::SymmetricIdentifierHandleRef
source · pub struct SymmetricIdentifierHandleRef<'a> { /* private fields */ }Expand description
A reference to a user identifier
Implementations§
source§impl SymmetricIdentifierHandleRef<'_>
impl SymmetricIdentifierHandleRef<'_>
pub fn into_owned(self) -> SymmetricIdentifierHandle
Methods from Deref<Target = NodeRemote>§
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>
Especially used to keep track of a conversation (b/c a certain ticket number may be expected)
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 HDP server. This should always be used to communicate with the server in order to obtain a ticket
pub async fn send_callback_subscription(
&self,
request: NodeRequest,
) -> Result<KernelStreamSubscription, NetworkError>
pub async fn send_callback_subscription( &self, request: NodeRequest, ) -> Result<KernelStreamSubscription, 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
Trait Implementations§
source§impl<'a> Debug for SymmetricIdentifierHandleRef<'a>
impl<'a> Debug for SymmetricIdentifierHandleRef<'a>
source§impl Deref for SymmetricIdentifierHandleRef<'_>
impl Deref for SymmetricIdentifierHandleRef<'_>
source§impl From<SymmetricIdentifierHandleRef<'_>> for SymmetricIdentifierHandle
impl From<SymmetricIdentifierHandleRef<'_>> for SymmetricIdentifierHandle
source§fn from(this: SymmetricIdentifierHandleRef<'_>) -> Self
fn from(this: SymmetricIdentifierHandleRef<'_>) -> Self
Converts to this type from the input type.
source§impl TargetLockedRemote for SymmetricIdentifierHandleRef<'_>
impl TargetLockedRemote for SymmetricIdentifierHandleRef<'_>
fn user(&self) -> &VirtualTargetType
fn remote(&self) -> &NodeRemote
fn target_username(&self) -> Option<&String>
fn user_mut(&mut self) -> &mut VirtualTargetType
fn session_security_settings(&self) -> Option<&SessionSecuritySettings>
Auto Trait Implementations§
impl<'a> Freeze for SymmetricIdentifierHandleRef<'a>
impl<'a> !RefUnwindSafe for SymmetricIdentifierHandleRef<'a>
impl<'a> Send for SymmetricIdentifierHandleRef<'a>
impl<'a> Sync for SymmetricIdentifierHandleRef<'a>
impl<'a> Unpin for SymmetricIdentifierHandleRef<'a>
impl<'a> !UnwindSafe for SymmetricIdentifierHandleRef<'a>
Blanket Implementations§
source§impl<T> BackendHandler for Twhere
T: TargetLockedRemote,
impl<T> BackendHandler for Twhere
T: TargetLockedRemote,
source§fn get<'life0, 'life1, 'async_trait>(
&'life0 self,
key: &'life1 str,
) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn get<'life0, 'life1, 'async_trait>(
&'life0 self,
key: &'life1 str,
) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Gets a value from the backend
source§fn remove<'life0, 'life1, 'async_trait>(
&'life0 self,
key: &'life1 str,
) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn remove<'life0, 'life1, 'async_trait>(
&'life0 self,
key: &'life1 str,
) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Removes a value from the backend, returning the previous value
source§fn set<'life0, 'life1, 'async_trait>(
&'life0 self,
key: &'life1 str,
value: Vec<u8>,
) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn set<'life0, 'life1, 'async_trait>(
&'life0 self,
key: &'life1 str,
value: Vec<u8>,
) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Stores a value in the backend, either creating or overwriting any pre-existing value
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>
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
source§impl<T> ProtocolRemoteTargetExt for Twhere
T: TargetLockedRemote,
impl<T> ProtocolRemoteTargetExt for Twhere
T: TargetLockedRemote,
source§fn send_file_with_custom_opts<'life0, 'async_trait, T>(
&'life0 self,
source: T,
chunk_size: usize,
transfer_type: TransferType,
) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>where
T: 'async_trait + ObjectSource,
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn send_file_with_custom_opts<'life0, 'async_trait, T>(
&'life0 self,
source: T,
chunk_size: usize,
transfer_type: TransferType,
) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>where
T: 'async_trait + ObjectSource,
Self: Sync + 'async_trait,
'life0: 'async_trait,
Sends a file with a custom size. The smaller the chunks, the higher the degree of scrambling, but the higher the performance cost. A chunk size of zero will use the default
source§fn send_file<'life0, 'async_trait, T>(
&'life0 self,
source: T,
) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>where
T: 'async_trait + ObjectSource,
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn send_file<'life0, 'async_trait, T>(
&'life0 self,
source: T,
) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>where
T: 'async_trait + ObjectSource,
Self: Sync + 'async_trait,
'life0: 'async_trait,
Sends a file to the provided target using the default chunking size
source§fn remote_encrypted_virtual_filesystem_push_custom_chunking<'life0, 'async_trait, T, R>(
&'life0 self,
source: T,
virtual_directory: R,
chunk_size: usize,
security_level: SecurityLevel,
) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>where
T: 'async_trait + ObjectSource,
R: 'async_trait + Into<PathBuf> + Send,
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn remote_encrypted_virtual_filesystem_push_custom_chunking<'life0, 'async_trait, T, R>(
&'life0 self,
source: T,
virtual_directory: R,
chunk_size: usize,
security_level: SecurityLevel,
) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>where
T: 'async_trait + ObjectSource,
R: 'async_trait + Into<PathBuf> + Send,
Self: Sync + 'async_trait,
'life0: 'async_trait,
Sends a file to the provided target using custom chunking size with local encryption.
Only this local node may decrypt the information send to the adjacent node.
source§fn remote_encrypted_virtual_filesystem_push<'life0, 'async_trait, T, R>(
&'life0 self,
source: T,
virtual_directory: R,
security_level: SecurityLevel,
) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>where
T: 'async_trait + ObjectSource,
R: 'async_trait + Into<PathBuf> + Send,
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn remote_encrypted_virtual_filesystem_push<'life0, 'async_trait, T, R>(
&'life0 self,
source: T,
virtual_directory: R,
security_level: SecurityLevel,
) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>where
T: 'async_trait + ObjectSource,
R: 'async_trait + Into<PathBuf> + Send,
Self: Sync + 'async_trait,
'life0: 'async_trait,
Sends a file to the provided target using the default chunking size with local encryption.
Only this local node may decrypt the information send to the adjacent node.
source§fn remote_encrypted_virtual_filesystem_pull<'life0, 'async_trait, R>(
&'life0 self,
virtual_directory: R,
transfer_security_level: SecurityLevel,
delete_on_pull: bool,
) -> Pin<Box<dyn Future<Output = Result<PathBuf, NetworkError>> + Send + 'async_trait>>
fn remote_encrypted_virtual_filesystem_pull<'life0, 'async_trait, R>( &'life0 self, virtual_directory: R, transfer_security_level: SecurityLevel, delete_on_pull: bool, ) -> Pin<Box<dyn Future<Output = Result<PathBuf, NetworkError>> + Send + 'async_trait>>
Pulls a virtual file from the RE-VFS. If
delete_on_pull is true, then, the virtual file
will be taken from the RE-VFSsource§fn remote_encrypted_virtual_filesystem_delete<'life0, 'async_trait, R>(
&'life0 self,
virtual_directory: R,
) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>
fn remote_encrypted_virtual_filesystem_delete<'life0, 'async_trait, R>( &'life0 self, virtual_directory: R, ) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>
Deletes the file from the RE-VFS. If the contents are desired on delete,
consider calling
Self::remote_encrypted_virtual_filesystem_pull with the delete
parameter set to truesource§fn connect_to_peer_custom<'life0, 'async_trait>(
&'life0 self,
session_security_settings: SessionSecuritySettings,
udp_mode: UdpMode,
peer_session_password: Option<PreSharedKey>,
) -> Pin<Box<dyn Future<Output = Result<PeerConnectSuccess, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn connect_to_peer_custom<'life0, 'async_trait>(
&'life0 self,
session_security_settings: SessionSecuritySettings,
udp_mode: UdpMode,
peer_session_password: Option<PreSharedKey>,
) -> Pin<Box<dyn Future<Output = Result<PeerConnectSuccess, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
Connects to the peer with custom settings
source§fn connect_to_peer<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Result<PeerConnectSuccess, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn connect_to_peer<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Result<PeerConnectSuccess, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
Connects to the target peer with default settings
source§fn register_to_peer<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Result<PeerRegisterStatus, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn register_to_peer<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Result<PeerRegisterStatus, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
Posts a registration request to a peer
source§fn deregister<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn deregister<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
Deregisters the currently locked target. If the target is a client to server
connection, deregisters from the server. If the target is a p2p connection,
deregisters the p2p
fn disconnect<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Result<(), NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn create_group<'life0, 'async_trait>(
&'life0 self,
initial_users_to_invite: Option<Vec<UserIdentifier>>,
) -> Pin<Box<dyn Future<Output = Result<GroupChannel, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
source§fn list_owned_groups<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Result<Vec<MessageGroupKey>, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn list_owned_groups<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Result<Vec<MessageGroupKey>, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
Lists all groups that which the current peer owns
source§fn rekey<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Result<Option<u32>, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
fn rekey<'life0, 'async_trait>(
&'life0 self,
) -> Pin<Box<dyn Future<Output = Result<Option<u32>, NetworkError>> + Send + 'async_trait>>where
Self: Sync + 'async_trait,
'life0: 'async_trait,
Begins a re-key, updating the container in the process.
Returns the new key matrix version. Does not return the new key version
if the rekey fails, or, if a current rekey is already executing
§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.