pub struct BaseClientBuilder<C, S: MixnetClientStorage> { /* private fields */ }Implementations§
Source§impl<C, S> BaseClientBuilder<C, S>
impl<C, S> BaseClientBuilder<C, S>
pub fn new( base_config: Config, client_store: S, dkg_query_client: Option<C>, ) -> BaseClientBuilder<C, S>
pub fn with_derivation_material( self, derivation_material: Option<DerivationMaterial>, ) -> Self
Sourcepub fn with_nym_api_urls(self, nym_api_urls: Vec<ApiUrl>) -> Self
pub fn with_nym_api_urls(self, nym_api_urls: Vec<ApiUrl>) -> Self
Set Nym API URLs for domain fronting support.
When provided, the client will use these API URLs (which include front_hosts) to construct HTTP clients with domain fronting enabled.
pub fn with_forget_me(self, forget_me: &ForgetMe) -> Self
pub fn with_remember_me(self, remember_me: &RememberMe) -> Self
pub fn with_gateway_setup(self, setup: GatewaySetup) -> Self
pub fn with_wait_for_gateway(self, wait_for_gateway: bool) -> Self
pub fn with_topology_provider( self, provider: Box<dyn TopologyProvider + Send + Sync>, ) -> Self
pub fn with_gateway_transceiver( self, sender: Box<dyn GatewayTransceiver + Send>, ) -> Self
pub fn with_shutdown(self, shutdown: ShutdownTracker) -> Self
pub fn with_event_tx(self, event_tx: EventSender) -> Self
pub fn with_user_agent(self, user_agent: UserAgent) -> Self
pub fn with_stored_topology<P: AsRef<Path>>( self, file: P, ) -> Result<Self, ClientCoreError>
pub fn with_connection_fd_callback( self, callback: Arc<dyn Fn(RawFd) + Send + Sync>, ) -> Self
pub async fn start_base(self) -> Result<BaseClient, ClientCoreError>where
S::ReplyStore: Send + Sync,
<S::KeyStore as KeyStore>::StorageError: Send + Sync,
<S::ReplyStore as ReplyStorageBackend>::StorageError: Sync + Send,
<S::CredentialStore as CredentialStorage>::StorageError: Send + Sync + 'static,
<S::GatewaysDetailsStore as GatewaysDetailsStore>::StorageError: Sync + Send,
Auto Trait Implementations§
impl<C, S> Freeze for BaseClientBuilder<C, S>
impl<C, S> !RefUnwindSafe for BaseClientBuilder<C, S>
impl<C, S> Send for BaseClientBuilder<C, S>
impl<C, S> !Sync for BaseClientBuilder<C, S>
impl<C, S> Unpin for BaseClientBuilder<C, S>
impl<C, S> !UnwindSafe for BaseClientBuilder<C, S>
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> Deprecatable for T
impl<T> Deprecatable for T
fn deprecate(self) -> Deprecated<Self>where
Self: Sized,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§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 moreSource§impl<T> OptionalSet for T
impl<T> OptionalSet for T
Source§fn with_optional<F, T>(self, f: F, val: Option<T>) -> Self
fn with_optional<F, T>(self, f: F, val: Option<T>) -> Self
If the value is available (i.e.
Some), the provided closure is applied.
Otherwise self is returned with no modifications.Source§fn with_validated_optional<F, T, V, E>(
self,
f: F,
value: Option<T>,
validate: V,
) -> Result<Self, E>
fn with_validated_optional<F, T, V, E>( self, f: F, value: Option<T>, validate: V, ) -> Result<Self, E>
If the value is available (i.e.
Some) it is validated and then the provided closure is applied.
Otherwise self is returned with no modifications.Source§fn with_optional_env<F, T>(self, f: F, val: Option<T>, env_var: &str) -> Self
fn with_optional_env<F, T>(self, f: F, val: Option<T>, env_var: &str) -> Self
If the value is available (i.e.
Some), the provided closure is applied.
Otherwise, if the environment was configured and the corresponding variable was set,
the value is parsed using the FromStr implementation and the closure is applied on that instead.
Finally, if none of those were available, self is returned with no modifications.Source§fn with_optional_custom_env<F, T, G>(
self,
f: F,
val: Option<T>,
env_var: &str,
parser: G,
) -> Self
fn with_optional_custom_env<F, T, G>( self, f: F, val: Option<T>, env_var: &str, parser: G, ) -> Self
If the value is available (i.e.
Some), the provided closure is applied.
Otherwise, if the environment was configured and the corresponding variable was set,
the value is parsed using the provided parser and the closure is applied on that instead.
Finally, if none of those were available, self is returned with no modifications.