Struct ClientIdentity 

pub struct ClientIdentity {
    pub uuid: Uuid,
    pub id_type: String,
    pub identify: String,
    pub name: Option<String>,
    pub user_id: Uuid,
    pub enabled: bool,
    pub suspended: bool,
    pub owner_suspended: bool,
    pub created_at: i64,
    pub updated_at: i64,
}

A client that Relay recognises (by source IP, DoT hostname or DoH path), so that sinkhole lists can be linked to it.

Fields

uuid: Uuid

Identity id.

id_type: String

IP, Hostname, Path or None (kept as a string for forward compatibility); see ClientIdentityType and ClientIdentity::kind.

identify: String

The identifying value, unique across the whole platform: the client’s IP address for IP/None; for Hostname/Path a value Core generated (16 characters of a-z2-7), the DoT hostname label or DoH path part the client is configured with.

name: Option<String>

The owner’s label for the identity, 1–64 characters; Core only, Relay never sees it. Not unique.

user_id: Uuid

Owning user.

enabled: bool

The owner’s switch; a disabled identity is not recognised by Relay.

suspended: bool

Suspended by an Admin. The owner can still read and delete it, but changes and new sinkhole links answer ErrorCode::Suspended.

owner_suspended: bool

The owning user is suspended; the identity then behaves as suspended too.

created_at: i64

Unix seconds.

updated_at: i64

Unix seconds.

Implementations

impl ClientIdentity

pub fn kind(&self) -> Option<ClientIdentityType>

id_type in its typed form, if this SDK version knows it.

pub fn is_suspended(&self) -> bool

Whether Core refuses changes to the identity: suspended itself or through its owner.

pub fn label(&self) -> &str

The name if it has one, else identify: how to show the identity to a person.

Trait Implementations

impl Clone for ClientIdentity

fn clone(&self) -> ClientIdentity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientIdentity

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClientIdentity

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ClientIdentity

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.