BaseClientBuilder

Struct BaseClientBuilder 

Source
pub struct BaseClientBuilder<C, S: MixnetClientStorage> { /* private fields */ }

Implementations§

Source§

impl<C, S> BaseClientBuilder<C, S>
where S: MixnetClientStorage + 'static, C: DkgQueryClient + Send + Sync + 'static,

Source

pub fn new( base_config: Config, client_store: S, dkg_query_client: Option<C>, ) -> BaseClientBuilder<C, S>

Source

pub fn with_derivation_material( self, derivation_material: Option<DerivationMaterial>, ) -> Self

Source

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.

Source

pub fn with_forget_me(self, forget_me: &ForgetMe) -> Self

Source

pub fn with_remember_me(self, remember_me: &RememberMe) -> Self

Source

pub fn with_gateway_setup(self, setup: GatewaySetup) -> Self

Source

pub fn with_wait_for_gateway(self, wait_for_gateway: bool) -> Self

Source

pub fn with_topology_provider( self, provider: Box<dyn TopologyProvider + Send + Sync>, ) -> Self

Source

pub fn with_gateway_transceiver( self, sender: Box<dyn GatewayTransceiver + Send>, ) -> Self

Source

pub fn with_shutdown(self, shutdown: ShutdownTracker) -> Self

Source

pub fn with_event_tx(self, event_tx: EventSender) -> Self

Source

pub fn with_user_agent(self, user_agent: UserAgent) -> Self

Source

pub fn with_stored_topology<P: AsRef<Path>>( self, file: P, ) -> Result<Self, ClientCoreError>

Source

pub fn with_connection_fd_callback( self, callback: Arc<dyn Fn(RawFd) + Send + Sync>, ) -> Self

Source

pub async fn start_base(self) -> Result<BaseClient, ClientCoreError>

Auto Trait Implementations§

§

impl<C, S> Freeze for BaseClientBuilder<C, S>
where S: Freeze, C: Freeze,

§

impl<C, S> !RefUnwindSafe for BaseClientBuilder<C, S>

§

impl<C, S> Send for BaseClientBuilder<C, S>
where S: Send, C: Send,

§

impl<C, S> !Sync for BaseClientBuilder<C, S>

§

impl<C, S> Unpin for BaseClientBuilder<C, S>
where S: Unpin, C: Unpin,

§

impl<C, S> !UnwindSafe for BaseClientBuilder<C, S>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<U> As for U

Source§

fn as_<T>(self) -> T
where T: CastFrom<U>,

Casts self to type T. The semantics of numeric casting with the as operator are followed, so <T as As>::as_::<U> can be used in the same way as T as U for numeric conversions. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Deprecatable for T

Source§

fn deprecate(self) -> Deprecated<Self>
where Self: Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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
Source§

impl<T> OptionalSet for T

Source§

fn with_optional<F, T>(self, f: F, val: Option<T>) -> Self
where F: Fn(Self, T) -> Self, Self: Sized,

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>
where F: Fn(Self, T) -> Self, V: Fn(&T) -> Result<(), E>, Self: Sized,

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
where F: Fn(Self, T) -> Self, T: FromStr, <T as FromStr>::Err: Debug, Self: Sized,

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
where F: Fn(Self, T) -> Self, G: Fn(&str) -> T, Self: Sized,

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.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more