Struct RelayUsage Copy item path

impl RelayUsage

pub fn any_exit(_cfg: &RelaySelectionConfig<'_>) -> Self

Require a relay that exits to at least one port.

This usage is generally suitable as the final relay for a testing circuit of some kind, or for a circuit that needs to look like an exit circuit without actually being useful for any exit in particular.

pub fn exit_to_all_ports( cfg: &RelaySelectionConfig<'_>, ports: Vec<TargetPort>, ) -> Self

Require a relay that exits to every port in a given list.

pub fn exit_to_any_port( cfg: &RelaySelectionConfig<'_>, ports: Vec<TargetPort>, ) -> Self

Require a relay that exits to at least one port in a given list.

pub fn middle_relay(known_final_hop_usage: Option<&RelayUsage>) -> Self

Require a relay that is suitable for a middle relay.

If known_final_hop_usage is provided, then the middle relay must support any additional properties needed in order to build a circuit for the usage of the final hop.

If known_final_hop_usage is not provided, then the middle relay must support all possible such additional properties.

(Note that providing a known_final_hop_usage can only weaken the requirements of this usage.)

pub fn new_intro_point() -> Self

Require a relay that is suitable as a newly selected introduction point.

This usage is suitable for selecting new introduction points for an onion service. When deciding whether to keep an introduction point, use RelayUsage::continuing_intro_point.

pub fn continuing_intro_point() -> Self

Require a relay that is suitable to keep using as a pre-existing introduction point.

pub fn new_guard() -> Self

Require a relay that is suitable as a newly selected guard.

This usage is suitable for selecting new guards. When deciding whether to keep a guard, use RelayUsage::continuing_guard.

pub fn continuing_guard() -> Self

Require a relay that is suitable to keep using as a pre-existing guard.

pub fn vanguard() -> Self

Available on crate feature vanguards only.

Require a relay that is suitable as a vanguard.

pub fn directory_cache() -> Self

Require a relay that is suitable to use for a directory request.

Note that this usage is suitable for fetching consensuses, authority certificates, descriptors and microdescriptors. It is not suitable for use with the HsDir system.

pub fn new_rend_point() -> Self

Require a relay that is suitable as a newly selected rendezvous point (as chosen by a client to connect to an onion service).

Trait Implementations§

impl Clone for RelayUsage

fn clone(&self) -> RelayUsage

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 RelayUsage

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

Formats the value using the given formatter. Read more

impl LowLevelRelayPredicate for RelayUsage

fn low_level_predicate_permits_relay(&self, relay_in: &Relay<'_>) -> bool

Return true if relay provides this predicate.

Auto Trait Implementations§

impl UnwindSafe for RelayUsage

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> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> DowncastSend for T
where T: Any + Send,

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.

impl<T> DowncastSync for T
where T: Any + Send + Sync,

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.

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,