Struct libsignal_protocol::ProtocolAddress

pub struct ProtocolAddress { /* private fields */ }

Represents a unique Signal client instance as (<user ID>, <device ID>) pair.

Implementations

impl ProtocolAddress

pub fn new(name: String, device_id: DeviceId) -> ProtocolAddress

Create a new address.

• name defines a user’s public identity, and therefore must be globally unique to that user.
• Each Signal client instance then has its own device_id, which must be unique among all clients for that user.

 use libsignal_core::{DeviceId, ProtocolAddress};

 // This is a unique id for some user, typically a UUID.
 let user_id: String = "04899A85-4C9E-44CC-8428-A02AB69335F1".to_string();
 // Each client instance representing that user has a unique device id.
 let device_id: DeviceId = 2_u32.into();
 let address = ProtocolAddress::new(user_id.clone(), device_id);

 assert!(address.name() == &user_id);
 assert!(address.device_id() == device_id);

pub fn name(&self) -> &str

A unique identifier for the target user. This is usually a UUID.

pub fn device_id(&self) -> DeviceId

An identifier representing a particular Signal client instance to send to.

For example, if a user has set up Signal on both their phone and laptop, a particular message sent to the user will still only go to a single device. So when a user sends a message to another user at all, they’re actually sending a message to every device.

Trait Implementations

impl Clone for ProtocolAddress

fn clone(&self) -> ProtocolAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolAddress

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

Formats the value using the given formatter.

impl Display for ProtocolAddress

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

Formats the value using the given formatter.

impl Hash for ProtocolAddress

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ProtocolAddress

fn cmp(&self, other: &ProtocolAddress) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ProtocolAddress

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ProtocolAddress

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for ProtocolAddress

impl StructuralPartialEq for ProtocolAddress