Module citadel_sdk::prelude
source · Expand description
Convenience import for building applications
Re-exports
pub use crate::backend_kv_store::BackendHandler;pub use crate::prefabs::client::peer_connection::PeerConnectionSetupAggregator;pub use crate::prefabs::client::PrefabFunctions;pub use crate::responses;pub use crate::remote_ext::*;
Structs
- The default manager for handling the list of users stored locally. It also allows for user creation, and is used especially for when creating a new user via the registration service.
- For passing metadata from a cnac
- Ensures that if a panic occurs in a task, the panic backtrace prints and halts the program
- Creates a KernelExecutor
- Used for fine-tuning parameters within the [
KernelExecutor] - Options for creating message groups
- Used to construct a running client/peer or server instance
- An awaitable future whose return value propagates any internal protocol or kernel-level errors
- allows convenient communication with the server
- Used to keep track of file transfer progress for either sender or receiver orientation
- A stream interface for receiving secure packets NOTE: on drop, if this is used for a P2P connection, disconnection will occur
- For use in the TOML config as well as for during the Post-login phase
- A memory-secure wrapper for shipping around Bytes
- A thin wrapper used for convenient creation of zero-copy outgoing buffers
- Miscellaneous settings for a node serving connections
- Passed to the services handler post-login at the server. Intended to be passed to the client afterwards
- A convenience structure for executing commands that depend on a specific registered user
- A reference to a user identifier
- A type sent through the server when a request is made
Enums
- Arguments for connecting to a node
- Used when constructing the account manager
- If force_login is true, the protocol will disconnect any previously existent sessions in the session manager attributed to the account logging-in (so long as login succeeds) The default is a Standard login that will with force_login set to false
- For saving the state of client-side connections
- The basic error type for this crate
- These are sent down the stack into the server. Most of the requests expect a ticket ID in order for processes sitting above the [Kernel] to know how the request went
- This type is for relaying results between the lower-level protocol and the higher-level kernel
- Used for determining the proper action when loading the server
- When creating credentials, this is required
- Provides the enumeration for all security levels
- A convenience wrapper for passing arguments to functions that require searches for a user
Traits
- The NetKernel is the thread-safe interface between the single-threaded OR multi-threaded async protocol and your network application
- Convenient serialization methods for types that #[derive(Serialize, Deserialize)]
Functions
- Uses: https://www.ory.sh/choose-recommended-argon2-parameters-password-hashing/ “To reach the desired execution time, you can tweak two variables. It is recommended to start with the highest amount of memory possible and one iteration. Reduce the memory until one hashing operation takes less than your desired duration. Next, advance the number of iterations to approach the desired execution time as close as possible”
Type Definitions
- For readability