Struct NodeRequest 

pub struct NodeRequest {

    pub id: i64,
    pub name: String,
    pub remark: String,
    pub scheme: NodeScheme,
    pub address: String,
    pub port: u16,
    pub base_path: String,
    pub enable: bool,
    pub allow_private_address: bool,
    pub tls_verify_mode: NodeTlsVerifyMode,
    pub pinned_cert_sha256: String,
    pub inbound_sync_mode: NodeInboundSyncMode,
    pub inbound_tags: Vec<String>,
    pub outbound_tag: String,
    /* private fields */
}

Complete writable node connection and synchronization configuration.

API tokens are write-only and redacted from Debug. The request encodes the controller’s three update states without allowing contradictory apiToken and clearApiToken fields.

Fields

id: i64

Existing node ID used when probing an edit form, or zero for a new node.

name: String

Unique configured name.

remark: String

Operator-visible description.

scheme: NodeScheme

Remote panel URL scheme.

address: String

Hostname or IP address without a port.

port: u16

Remote panel port.

base_path: String

Remote panel base path.

enable: bool

Whether node synchronization is enabled.

allow_private_address: bool

Whether guarded node connections may resolve to private addresses.

tls_verify_mode: NodeTlsVerifyMode

Node TLS verification/authentication mode.

pinned_cert_sha256: String

Base64 SHA-256 leaf-certificate pin.

inbound_sync_mode: NodeInboundSyncMode

Remote inbound import mode.

inbound_tags: Vec<String>

Remote inbound tags selected for import.

outbound_tag: String

Local Xray outbound used to reach the node.

Implementations

impl NodeRequest

pub fn new( name: impl Into<String>, address: impl Into<String>, port: u16, ) -> Self

Creates an enabled HTTPS node using normal certificate verification.

pub fn with_api_token(self, token: impl Into<String>) -> Self

Configures a replacement API token and returns the request.

pub fn set_api_token(&mut self, token: impl Into<String>)

Configures a replacement API token.

pub fn clear_stored_api_token(&mut self)

Explicitly clears the stored token on update.

3x-ui only permits an enabled tokenless node when mTLS is active.

pub fn retain_stored_api_token(&mut self)

Omits both credential fields so an update retains the stored token.

pub fn api_token(&self) -> Option<&str>

Exposes the replacement token when explicitly needed by the caller.

pub const fn clears_stored_api_token(&self) -> bool

Returns whether this update explicitly clears the stored token.

Trait Implementations

impl Clone for NodeRequest

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 NodeRequest

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

Formats the value using the given formatter.

impl Serialize for NodeRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.