Enum Control 

pub enum Control {
    Init {
        version: u32,
        host: String,
        superuser: Option<Value>,
    },
    Open {
        channel: String,
        payload: String,
        options: Map<String, Value>,
    },
    Done {
        channel: String,
    },
    Close {
        channel: String,
        problem: Option<String>,
    },
}

Control messages we SEND (empty-channel JSON, tagged by command).

Variants

Init

Initial handshake message.

Fields

version: u32

Protocol version.

host: String

Host label.

superuser: Option<Value>

Eagerly start a privileged superuser peer at init time. cockpit only routes superuser: "require" channels once such a peer exists; without this the bridge denies every privileged channel (access-denied). {"id": "sudo"} selects the sudo escalation bridge, which works headlessly when the invoking user has passwordless sudo.

Open

Open a new channel.

Fields

channel: String

Channel id to allocate.

payload: String

Channel payload type (e.g. dbus-json3, stream).

options: Map<String, Value>

Additional open options (bus, name, spawn, …).

Done

Signal end of input on a channel.

Fields

channel: String

Channel being finished.

Close

Close a channel, optionally reporting a problem.

Fields

channel: String

Channel to close.

problem: Option<String>

Problem kind if the close is abnormal.

Implementations

impl Control

pub fn open(channel: &str, payload: &str) -> Control

Build an Open control for channel with the given payload type.

pub fn opt(self, key: &str, value: Value) -> Control

Builder helper for Open options (bus, name, spawn, …).

pub fn to_json(&self) -> Vec<u8>

Serialize this control message to JSON bytes.

Returns a safe-close frame on serialization failure so the bridge sees a well-formed command rather than receiving nothing.

Trait Implementations

impl Debug for Control

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

Formats the value using the given formatter.

impl Serialize for Control

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

where __S: Serializer,

Serialize this value into the given Serde serializer.