Struct HelperInfo 

pub struct HelperInfo {
    pub channel_id: u64,
    pub transport_uri: String,
    pub shared_key: Vec<u8>,
    pub communication_info: HashMap<String, String>,
}

Per-helper metadata stored inside the secret bag for recovery.

Each entry records the pairing state of a Helper so that recovery can re-establish communication channels without external configuration.

Fields

channel_id: u64

Unique channel identifier assigned during pairing.

transport_uri: String

The Helper’s message endpoint URI.

shared_key: Vec<u8>

Symmetric key negotiated during pairing (32 bytes).

communication_info: HashMap<String, String>

App-level identity metadata for this helper. Free-form key/value pairs — the protocol treats it as opaque, never inspects keys or values, and copies it verbatim from Channel::communication_info at protect-time. A recovering owner who decodes the bag can use this to recognise each helper (e.g. by a "name" key the app set on pairing).

Wire stability: the now-removed name: String was previously at tag 3. Using tag 5 lets prost silently drop the old name field when decoding legacy bags (empty communication_info), and lets older codebases silently drop this new field when decoding new bags. Degraded but not broken in either direction.

Trait Implementations

impl Clone for HelperInfo

fn clone(&self) -> HelperInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HelperInfo

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

Formats the value using the given formatter.

impl Default for HelperInfo

fn default() -> Self

Returns the “default value” for a type.

impl Message for HelperInfo

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for HelperInfo

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HelperInfo