Struct SetupPayload 

pub struct SetupPayload {
    pub version: u8,
    pub vendor_id: Option<u16>,
    pub product_id: Option<u16>,
    pub commissioning_flow: CommissioningFlow,
    pub discovery_capabilities: DiscoveryCapabilities,
    pub discriminator: Discriminator,
    pub passcode: Passcode,
}

The decoded contents of a Matter onboarding payload (QR code or manual pairing code), as defined in Matter Core Spec §5.1.3.

Roundtrip identities:

// For every valid `p` produced by M6.1:
assert_eq!(parse_qr(&encode_qr(&p)?)?, p);
assert_eq!(parse_manual_code(&encode_manual_code(&p)), p);  // see caveat below

The manual-code roundtrip preserves the upper four bits of the discriminator (the short discriminator) and zero-extends the rest. A SetupPayload decoded from a manual code therefore has a discriminator whose lower 8 bits are zero, regardless of what the physical device’s long discriminator actually is. Callers matching against mDNS records should compare on the short discriminator in that case.

Fields

version: u8

Onboarding payload version. Currently always 0 (Matter Core Spec §5.1.3.1 Table 39). Reserved for future use.

vendor_id: Option<u16>

Vendor ID. None if the source was an 11-digit manual code, which does not carry VID/PID.

product_id: Option<u16>

Product ID. Pair with vendor_id — both are Some or both None.

commissioning_flow: CommissioningFlow

Commissioning flow indicator.

discovery_capabilities: DiscoveryCapabilities

Bitmask of discovery transports the device supports while commissionable. Always present in QR codes; manual codes do not carry this field and decode it as the empty set.

discriminator: Discriminator

12-bit Long Discriminator. See the type-level rustdoc for the manual-code caveat.

passcode: Passcode

27-bit passcode.

Trait Implementations

impl Clone for SetupPayload

fn clone(&self) -> SetupPayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SetupPayload

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

Formats the value using the given formatter.

impl Eq for SetupPayload

impl PartialEq for SetupPayload

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SetupPayload