Struct ClientConfig 

pub struct ClientConfig {

    pub protocol_id: String,
    pub security: String,
    pub password: String,
    pub flow: String,
    pub reverse: Option<ClientReverse>,
    pub auth: String,
    pub private_key: String,
    pub public_key: String,
    pub allowed_ips: Vec<String>,
    pub allowed_ips_by_inbound: HashMap<i64, Vec<String>>,
    pub pre_shared_key: String,
    pub keep_alive: Option<i32>,
    pub forwarded_ports: String,
    pub secret: String,
    pub ad_tag: String,
    pub email: String,
    pub limit_ip: i32,
    pub limit_hwid: i32,
    pub total_gb: i64,
    pub expiry_time: i64,
    pub enable: bool,
    pub tg_id: i64,
    pub sub_id: String,
    pub group: String,
    pub comment: String,
    pub reset: i32,
    pub reset_day: i32,
    pub reset_max: i32,
    pub traffic_reset: Option<TrafficReset>,
    pub traffic_reset_day: i32,
    pub created_at: i64,
    pub updated_at: i64,
}

Complete writable client configuration accepted by 3x-ui.

Protocol-specific credentials may be left empty on create; 3x-ui generates the appropriate UUID, password, auth value, or MTProto secret from the target inbound. Use ClientRecord::to_config before replacement updates.

Fields

protocol_id: String

VMess/VLESS UUID.

security: String

Protocol security method.

password: String

Trojan or Shadowsocks password/key.

flow: String

XTLS flow value.

reverse: Option<ClientReverse>

VLESS reverse-proxy settings.

auth: String

Hysteria authentication value.

private_key: String

WireGuard private key.

public_key: String

WireGuard public key.

allowed_ips: Vec<String>

WireGuard allowed networks.

allowed_ips_by_inbound: HashMap<i64, Vec<String>>

Per-inbound WireGuard/AmneziaWG allowed-network overrides.

pre_shared_key: String

WireGuard pre-shared key.

keep_alive: Option<i32>

WireGuard keepalive seconds: None preserves the stored value; Some(0) disables it.

forwarded_ports: String

AmneziaWG per-client port-forwarding specification.

secret: String

MTProto client secret.

ad_tag: String

MTProto advertisement tag.

email: String

Unique client email/name.

limit_ip: i32

Maximum concurrent source IP count.

limit_hwid: i32

Maximum registered subscription devices; zero disables HWID limiting.

total_gb: i64

Traffic quota in bytes, despite the historical totalGB wire name.

expiry_time: i64

Expiration timestamp in milliseconds; zero means unlimited.

enable: bool

Whether the client is enabled.

tg_id: i64

Telegram user identifier for notifications.

sub_id: String

Subscription identifier.

group: String

Optional logical group label.

comment: String

Operator comment.

reset: i32

Automatic reset period encoded by 3x-ui.

reset_day: i32

Calendar renewal day; zero keeps interval-based renewal.

reset_max: i32

Maximum automatic renewals; zero is unlimited.

traffic_reset: Option<TrafficReset>

Independent per-client traffic reset cycle.

traffic_reset_day: i32

Day of month used by the per-client monthly reset cycle.

created_at: i64

Creation timestamp in milliseconds used by import/export.

updated_at: i64

Update timestamp in milliseconds used by import/export.

Implementations

impl ClientConfig

pub fn new(email: impl Into<String>) -> Self

Creates an enabled, unlimited client and lets 3x-ui generate credentials.

Trait Implementations

impl Clone for ClientConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientConfig

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

Formats the value using the given formatter.

impl Default for ClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClientConfig

where ClientConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ClientConfig

impl PartialEq for ClientConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ClientConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ClientConfig