Struct HelloPayload 

pub struct HelloPayload {
    pub token: Option<String>,
    pub api_key: Option<String>,
    pub client_name: Option<String>,
    pub version: i64,
}

HELLO request payload — sent as the FIRST frame on a connection.

At least one of token / api_key should be populated when the server has auth enabled. When the server runs in single-user mode (auth.enabled: false), credentials are accepted-but-ignored and the connection runs as the implicit local admin.

Fields

token: Option<String>

Bearer JWT (same shape REST /auth/login returns).

api_key: Option<String>

API key.

client_name: Option<String>

User-Agent-style identifier surfaced in server-side tracing.

version: i64

Wire spec protocol version; defaults to 1.

Implementations

impl HelloPayload

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

Build a minimal HELLO payload identifying the client by name. No credentials — works against a server running in single-user mode (auth.enabled: false).

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

Attach a JWT bearer token. Replaces any previously set token/api_key.

pub fn with_api_key(self, api_key: impl Into<String>) -> Self

Attach an API key. Replaces any previously set token/api_key.

Trait Implementations

impl Clone for HelloPayload

fn clone(&self) -> HelloPayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HelloPayload

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

Formats the value using the given formatter.

impl Default for HelloPayload

fn default() -> HelloPayload

Returns the “default value” for a type.