Struct RpcConnBuilder Copy item path

impl RpcConnBuilder

pub fn new() -> Self

Create a new RpcConnBuilder to try connecting to an Arti instance.

By default, we search:

Any connect points listed in the environment variable $ARTI_RPC_CONNECT_PATH_OVERRIDE
Any connect points passed to RpcConnBuilder::prepend_* (Since these variables are prepended, the ones that are prepended last will be considered first.)
Any connect points listed in the environment variable $ARTI_RPC_CONNECT_PATH
Any connect files in ${ARTI_LOCAL_DATA}/rpc/connect.d
Any connect files in /etc/arti-rpc/connect.d (unix only)
[tor_rpc_connect::USER_DEFAULT_CONNECT_POINT]
[tor_rpc_connect::SYSTEM_DEFAULT_CONNECT_POINT] if present

pub fn prepend_literal_entry(&mut self, s: String)

Prepend a single literal connect point to the search path in this RpcConnBuilder.

This entry will be considered before any entries in the $ARTI_RPC_CONNECT_PATH environment variable but after any entry in the $ARTI_RPC_CONNECT_PATH_OVERRIDE environment variable.

This entry must be a literal connect point, expressed as a TOML table.

pub fn prepend_path(&mut self, p: String)

Prepend a single path entry to the search path in this RpcConnBuilder.

This entry will be considered before any entries in the $ARTI_RPC_CONNECT_PATH environment variable, but after any entry in the $ARTI_RPC_CONNECT_PATH_OVERRIDE environment variable.

This entry must be a path to a file or directory. It may contain variables to expand; they will be expanded according to the rules of [CfgPath], using the variables of [tor_config_path::arti_client_base_resolver].

pub fn prepend_literal_path(&mut self, p: PathBuf)

Prepend a single literal path entry to the search path in this RpcConnBuilder.

This entry will be considered before any entries in the $ARTI_RPC_CONNECT_PATH environment variable, but after any entry in the $ARTI_RPC_CONNECT_PATH_OVERRIDE environment variable.

Variables in this entry will not be expanded.

fn prepend_internal(&mut self, location: SearchLocation)

Prepend the application-provided SearchLocation to the path.

fn default_path_entries() -> Vec<SearchEntry>

Return the list of default path entries that we search after all user-provided entries.

fn all_entries(&self) -> Result<Vec<SearchEntry>, ConnectError>

Return a vector of every PathEntry that we should try to connect to.

pub fn connect(&self) -> Result<RpcConn, ConnectFailure>

Try to connect to an Arti process as specified by this Builder.

Trait Implementations§

impl Clone for RpcConnBuilder

fn clone(&self) -> RpcConnBuilder

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for RpcConnBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl Default for RpcConnBuilder

fn default() -> RpcConnBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl UnwindSafe for RpcConnBuilder

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,