Skip to main content

AttrDataBuilder

Struct AttrDataBuilder 

Source
pub struct AttrDataBuilder<P, const F: usize = 0> { /* private fields */ }
Expand description

Streaming builder for a single AttrData entry inside the WriteRequests array.

Field-state values:

  • 0: nothing written yet
  • 1: DataVersion decided
  • 2: Path written
  • 3: Data written (struct can be closed)

Implementations§

Source§

impl<P> AttrDataBuilder<P>

Source

pub fn new(p: P, tag: &TLVTag) -> Result<AttrDataBuilder<P>, Error>

Begin a new AttrData entry — opens a struct at the given tag. Use &TLVTag::Anonymous when pushed into the WriteRequests array (the typical case).

Source§

impl<P> AttrDataBuilder<P>

Source

pub fn data_version(self, value: u32) -> Result<AttrDataBuilder<P, 1>, Error>

Write the optional DataVersion field — used for optimistic-concurrency writes that should fail on stale data. Omit (don’t call) for unconditional writes; subsequent path* methods are also available on state 0 and implicitly skip this field.

Source§

impl<P> AttrDataBuilder<P>

Source

pub fn path( self, endpoint: u16, cluster: u32, attr: u32, ) -> Result<AttrDataBuilder<P, 2>, Error>

Write the concrete (endpoint, cluster, attribute) path, implicitly skipping DataVersion.

Source

pub fn path_from(self, path: &AttrPath) -> Result<AttrDataBuilder<P, 2>, Error>

Write the path from an existing crate::im::AttrPath, implicitly skipping DataVersion. Used by the snapshot→streaming bridge in ImClient::write.

Source§

impl<P> AttrDataBuilder<P, 1>

Source

pub fn path( self, endpoint: u16, cluster: u32, attr: u32, ) -> Result<AttrDataBuilder<P, 2>, Error>

Write the concrete (endpoint, cluster, attribute) path. This is the typical shape for attribute writes; wildcards aren’t generally meaningful for writes and aren’t exposed here. The path is encoded as a list (per spec AttributePathIB).

Source

pub fn path_from(self, path: &AttrPath) -> Result<AttrDataBuilder<P, 2>, Error>

Write the path from an existing crate::im::AttrPath. Used by the snapshot→streaming bridge in ImClient::write so the pre-built AttrPath (which may carry wildcards or list_index) is re-emitted faithfully. New call sites should prefer Self::path.

Source§

impl<P> AttrDataBuilder<P, 2>

Source

pub fn data<F>(self, f: F) -> Result<AttrDataBuilder<P, 3>, Error>
where F: FnOnce(&mut <P as TLVBuilderParent>::Write) -> Result<(), Error>,

Write the attribute value into the Data slot.

Per Matter Core spec AttributeDataIB.Data is “any TLV value.” The closure receives the parent’s TLVWrite and must emit exactly one TLV element tagged TLVTag::Context(2) (i.e. AttrDataTag::Data). The IM-level builder can’t enforce the inner type because the schema lives in the attribute the path named, not the IM message; the closure body is where the caller asserts the schema match (typically by calling a codegen-emitted typed writer).

Idiomatic call patterns:

// Any `T: ToTLV`:
.data(|w| 60u16.to_tlv(&TLVTag::Context(AttrDataTag::Data as u8), w))?

// A bool, raw:
.data(|w| w.bool(&TLVTag::Context(AttrDataTag::Data as u8), true))?

// A codegen-emitted typed helper that already knows the tag:
.data(|w| on_off::write_on_time_value(60u16, w))?
Source

pub fn data_builder<B>(self) -> Result<B, Error>
where B: TLVBuilder<AttrDataBuilder<P, 3>>,

Open the Data slot as a typed sub-builder.

Closure-free counterpart to data — hand back the codegen-emitted typed value builder for the attribute, already opened at AttrDataTag::Data. The caller fills the value, then calls .end() on the sub-builder; that close writes Data’s closing tag (for struct/array-valued attrs) and yields an AttrDataBuilder<P, 3>. The caller then .end()s once more to close the AttrData entry struct (the “double-end” pattern of the IM-client glue).

Useful for struct- or array-valued attributes (e.g. ACL entries). For scalars prefer the closure-based [data].

Soundness of the phantom typestate advance: see [CmdDataBuilder::data_builder].

Source§

impl<P> AttrDataBuilder<P, 3>

Source

pub fn end(self) -> Result<P, Error>

Close the AttrData struct and return the array builder so the caller can .push() another entry or .end() the array.

Trait Implementations§

Source§

impl<P, const F: usize> Debug for AttrDataBuilder<P, F>
where P: Debug,

Source§

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

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

impl<P> TLVBuilder<P> for AttrDataBuilder<P>

Source§

fn new(parent: P, tag: &TLVTag) -> Result<AttrDataBuilder<P>, Error>

Create a new TLV builder for the given parent and tag.
Source§

fn unchecked_into_parent(self) -> P

Convert itself into a writer. Read more
Source§

fn with<F>(self, f: F) -> Result<P, Error>
where F: FnOnce(Self) -> Result<P, Error>,

Call a closure with the builder and return the result.
Source§

impl<P, const F: usize> TLVBuilderParent for AttrDataBuilder<P, F>

Source§

type Write = <P as TLVBuilderParent>::Write

The type of the writer.
Source§

fn writer(&mut self) -> &mut <AttrDataBuilder<P, F> as TLVBuilderParent>::Write

Return a mutable reference to the writer.

Auto Trait Implementations§

§

impl<P, const F: usize> Freeze for AttrDataBuilder<P, F>
where P: Freeze,

§

impl<P, const F: usize> RefUnwindSafe for AttrDataBuilder<P, F>
where P: RefUnwindSafe,

§

impl<P, const F: usize> Send for AttrDataBuilder<P, F>
where P: Send,

§

impl<P, const F: usize> Sync for AttrDataBuilder<P, F>
where P: Sync,

§

impl<P, const F: usize> Unpin for AttrDataBuilder<P, F>
where P: Unpin,

§

impl<P, const F: usize> UnsafeUnpin for AttrDataBuilder<P, F>
where P: UnsafeUnpin,

§

impl<P, const F: usize> UnwindSafe for AttrDataBuilder<P, F>
where P: UnwindSafe,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, E> Init<T, E> for T

Source§

unsafe fn __init(self, slot: *mut T) -> Result<(), E>

Initializes slot. Read more
Source§

fn chain<F>(self, f: F) -> ChainInit<Self, F, T, E>
where F: FnOnce(&mut T) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, I> IntoFallibleInit<T> for I
where I: Init<T>,

Source§

fn into_fallible<E>(self) -> impl Init<T, E>

Convert the infallible initializer to a fallible one.
Source§

impl<Source, Target> OctetsInto<Target> for Source
where Target: OctetsFrom<Source>,

Source§

type Error = <Target as OctetsFrom<Source>>::Error

Source§

fn try_octets_into( self, ) -> Result<Target, <Source as OctetsInto<Target>>::Error>

Performs the conversion.
Source§

fn octets_into(self) -> Target
where Self::Error: Into<Infallible>,

Performs an infallible conversion.
Source§

impl<T, E> PinInit<T, E> for T

Source§

unsafe fn __pinned_init(self, slot: *mut T) -> Result<(), E>

Initializes slot. Read more
Source§

fn pin_chain<F>(self, f: F) -> ChainPinInit<Self, F, T, E>
where F: FnOnce(Pin<&mut T>) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V