Struct Endpoint 

pub struct Endpoint<'a> {
    pub id: u16,
    pub device_types: &'a [DeviceType],
    pub clusters: &'a [Cluster<'a>],
    pub client_clusters: &'a [u32],
    pub unique_id: Option<&'a str>,
    pub semantic_tags: &'a [SemanticTag<'a>],
}

A type modeling the endpoint meta-data in the Matter data model.

Fields

id: u16

The endpoint ID.

device_types: &'a [DeviceType]

The list of device types associated with this endpoint.

clusters: &'a [Cluster<'a>]

The list of server clusters present on this endpoint. These are advertised via Descriptor::ServerList and dispatched by the Handler chain on inbound IM messages.

client_clusters: &'a [u32]

The list of client cluster IDs present on this endpoint — i.e. clusters this endpoint initiates interactions for, rather than serves. Advertised verbatim via Descriptor::ClientList so commissioners know which Binding targets are meaningful for this endpoint. Empty by default; only meaningful on endpoints whose device type prescribes client clusters (e.g. OnOffLightSwitch = 0x0103 lists OnOff as a mandatory client). No Cluster<'a> value is needed because a client cluster has no attribute/command surface of its own — see Matter Core spec for the Descriptor::ClientList semantics.

unique_id: Option<&'a str>

The endpoint’s unique ID, advertised via Descriptor::EndpointUniqueID. None by default.

A manufacturer-assigned string (at most 32 bytes) that identifies this endpoint uniquely within the node, so that machine-to-machine integrations can keep addressing “the same” endpoint even if endpoint IDs get renumbered across software updates or bridge re-compositions.

Populating this also requires the endpoint’s Descriptor metadata to advertise the optional EndpointUniqueID attribute - see crate::dm::clusters::desc::CLUSTER_ENDPOINT_UNIQUE_ID.

semantic_tags: &'a [SemanticTag<'a>]

The semantic tags describing this endpoint, advertised via Descriptor::TagList. Empty by default.

These are only required when the node exposes several endpoints with the same device type under one parent: Matter Core spec 9.5 then demands that each carries a non-empty, mutually distinct TagList so the endpoints can be told apart. Populating this also requires the endpoint’s Descriptor metadata to advertise the TagList feature and attribute - see crate::dm::clusters::desc::CLUSTER_TAG_LIST.

Implementations

impl<'a> Endpoint<'a>

pub const fn new( id: u16, device_types: &'a [DeviceType], clusters: &'a [Cluster<'a>], ) -> Endpoint<'a>

Create a new Endpoint instance with no client clusters.

Use Self::new_with_clients when this endpoint should advertise client clusters via Descriptor::ClientList.

pub const fn new_with_clients( id: u16, device_types: &'a [DeviceType], clusters: &'a [Cluster<'a>], client_clusters: &'a [u32], ) -> Endpoint<'a>

Create a new Endpoint instance that advertises the given client cluster IDs in addition to its server clusters.

pub const fn with_tags( self, semantic_tags: &'a [SemanticTag<'a>], ) -> Endpoint<'a>

Return this endpoint with the given semantic tags attached, to be advertised via Descriptor::TagList.

The endpoint’s Descriptor cluster metadata must also advertise the attribute and feature - use crate::dm::clusters::desc::CLUSTER_TAG_LIST in place of the default DescHandler::CLUSTER, otherwise the tags are never reported.

pub const fn with_unique_id(self, unique_id: &'a str) -> Endpoint<'a>

Return this endpoint with the given unique ID attached, to be advertised via Descriptor::EndpointUniqueID.

The endpoint’s Descriptor cluster metadata must also advertise the attribute - use crate::dm::clusters::desc::CLUSTER_ENDPOINT_UNIQUE_ID in place of the default DescHandler::CLUSTER, otherwise the ID is never reported.

pub fn cluster(&self, id: u32) -> Option<&Cluster<'a>>

Return a reference to the cluster with the given ID, if it exists.

Trait Implementations

impl<'a> Clone for Endpoint<'a>

fn clone(&self) -> Endpoint<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Endpoint<'a>

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

Formats the value using the given formatter.

impl Display for Endpoint<'_>

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

Formats the value using the given formatter.