Skip to main content

Endpoint

Struct Endpoint 

Source
pub struct Endpoint<'a> {
    pub id: EndpointId,
    pub clusters: &'a [ClusterDescriptor<'a>],
    pub device_types: &'a [DeviceType],
    pub clients: &'a [ClusterId],
}
Expand description

One endpoint: a set of cluster instances (§7.2).

Fields§

§id: EndpointId

The endpoint id. Endpoint 0 is the root node (§9.2).

§clusters: &'a [ClusterDescriptor<'a>]

The clusters on it, sorted by cluster id.

§device_types: &'a [DeviceType]

The device types it conforms to (§9.5.6.1).

§9.5 requires “at least one device type entry”, and two layers read it: the Descriptor cluster publishes it as DeviceTypeList, and §6.6.6.2’s access control matches an ACL target’s DeviceType against it. Keeping it here is what stops those two from describing different devices.

§clients: &'a [ClusterId]

ClientList (§9.5.6.3) — the clusters this endpoint speaks as a client.

Not derivable from clusters: a ClusterDescriptor describes a server instance, and a client binding has no descriptor to be found in — a switch that controls a light is a client of On/Off and a server of nothing much.

It lives here rather than on the Descriptor cluster for the same reason device_types does: two layers read it, the Descriptor cluster publishing ClientList and §9.2’s device-type check demanding it, and a device type may require a cluster on the client side — §6.1’s On/Off Light Switch requires On/Off as a client and as nothing else, which is the only thing that tells it apart from a light.

Implementations§

Source§

impl<'a> Endpoint<'a>

Source

pub const fn new(id: EndpointId, clusters: &'a [ClusterDescriptor<'a>]) -> Self

An endpoint with clusters and no device types yet.

Source

pub const fn with_clients(self, clients: &'a [ClusterId]) -> Self

The same endpoint, declaring the clusters it speaks as a client (§9.5.6.3).

Source

pub const fn with_device_types(self, device_types: &'a [DeviceType]) -> Self

The same endpoint, declaring the device types of §9.5.6.1.

Source

pub fn has_device_type(&self, device_type: u32) -> bool

Whether this endpoint conforms to device_type.

§6.6.6.2’s endpoint_contains_device_type, which decides whether an ACL target that names a device type rather than an endpoint applies here.

Source§

impl<'a> Endpoint<'a>

Source

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

The descriptor for a cluster id on this endpoint.

Trait Implementations§

Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for Endpoint<'a>

Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Eq for Endpoint<'a>

Source§

impl<'a> PartialEq for Endpoint<'a>

Source§

fn eq(&self, other: &Endpoint<'a>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for Endpoint<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Endpoint<'a>

§

impl<'a> RefUnwindSafe for Endpoint<'a>

§

impl<'a> Send for Endpoint<'a>

§

impl<'a> Sync for Endpoint<'a>

§

impl<'a> Unpin for Endpoint<'a>

§

impl<'a> UnsafeUnpin for Endpoint<'a>

§

impl<'a> UnwindSafe for Endpoint<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.