Struct IsolationToken

pub struct IsolationToken(/* private fields */);

A token used to isolate unrelated streams on different circuits.

When two streams are associated with different isolation tokens, they can never share the same circuit.

Tokens created with IsolationToken::new are all different from one another, and different from tokens created with IsolationToken::no_isolation. However, tokens created with IsolationToken::no_isolation are all equal to one another.

Examples

Creating distinct isolation tokens:

let token_1 = IsolationToken::new();
let token_2 = IsolationToken::new();

assert_ne!(token_1, token_2);

// Demonstrating the behaviour of no_isolation() tokens:
assert_ne!(token_1, IsolationToken::no_isolation());
assert_eq!(IsolationToken::no_isolation(), IsolationToken::no_isolation());

Using an isolation token to route streams differently over the Tor network:

use arti_client::StreamPrefs;

let token_1 = IsolationToken::new();
let token_2 = IsolationToken::new();

let mut prefs_1 = StreamPrefs::new();
prefs_1.set_isolation(token_1);

let mut prefs_2 = StreamPrefs::new();
prefs_2.set_isolation(token_2);

// These two connections will come from different source IP addresses.
tor_client.connect(("example.com", 80), Some(prefs_1)).await?;
tor_client.connect(("example.com", 80), Some(prefs_2)).await?;

Implementations

impl IsolationToken

pub fn new() -> IsolationToken

Create a new IsolationToken, unequal to any other token this function has created.

Panics

Panics if we have already allocated 2^64 isolation tokens: in that case, we have exhausted the space of possible tokens, and it is no longer possible to ensure isolation.

pub fn no_isolation() -> IsolationToken

Create a new IsolationToken equal to every other token created with this function, but different from all tokens created with new.

This can be used when no isolation is wanted for some streams.

Trait Implementations

impl Clone for IsolationToken

fn clone(&self) -> IsolationToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IsolationToken

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

Formats the value using the given formatter.

impl IsolationHelper for IsolationToken

fn compatible_same_type(&self, other: &IsolationToken) -> bool

Returns whether self and other are compatible.

fn join_same_type(&self, other: &IsolationToken) -> Option<IsolationToken>

Join self and other into the intersection of what they allows.

impl Ord for IsolationToken

fn cmp(&self, other: &IsolationToken) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for IsolationToken

fn eq(&self, other: &IsolationToken) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for IsolationToken

fn partial_cmp(&self, other: &IsolationToken) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for IsolationToken

impl Eq for IsolationToken

impl StructuralPartialEq for IsolationToken