Struct SinkholeList 

pub struct SinkholeList {
    pub uuid: Uuid,
    pub name: Option<String>,
    pub owner_user_id: Option<Uuid>,
    pub is_shared: bool,
    pub list_type: String,
    pub created_at: i64,
    pub updated_at: i64,
    pub roles: Option<Vec<SinkholeRole>>,
}

A list of sinkhole rules (names to block or to allow). It applies to the client identities linked to it (SinkholeLink).

Relay allows every name by default. A name matching a Blacklist of the client is blocked; a name matching a Whitelist of the client is allowed even if a blacklist matches too (an exception, not “allow only these”).

Fields

uuid: Uuid

List id.

name: Option<String>

Optional label, 1–100 characters. Not unique: two lists may share a name.

owner_user_id: Option<Uuid>

Owning user. None for admin-managed lists (and lists created with a zone key before Core stopped allowing that).

is_shared: bool

Other users may link their client identities to it (but not read or change its rules).

list_type: String

Blacklist or Whitelist (kept as a string for forward compatibility); see SinkholeList::kind.

created_at: i64

Unix seconds.

updated_at: i64

Unix seconds.

roles: Option<Vec<SinkholeRole>>

The rules; only when read with SinkholeLists::get and with_roles = true.

Implementations

impl SinkholeList

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

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

Trait Implementations

impl Clone for SinkholeList

fn clone(&self) -> SinkholeList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SinkholeList

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SinkholeList

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SinkholeList

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

where __S: Serializer,

Serialize this value into the given Serde serializer.