Create an object from layout properties and an array of values.
NOTE This function returns undefined if invoked on a layout
that does not return its value as an Object. Objects are
returned for things that are a Structure, which includes
variant layouts if they are structures, and
excludes Unions. If you want this feature for a union
you must use getVariant to select the
desired layout.
an array of values that correspond to the default order for properties. As with {@link Layout#decode|decode} layout elements that have no property name are skipped when iterating over the array values. Only the top-level properties are assigned; arguments are not assigned to properties of contained layouts. Any unused values are ignored.
Calculate the span of a specific instance of a layout.
the buffer that contains an encoded instance.
Function to create an Object into which decoded properties will be written.
Used only for layouts that {@link Layout#decode|decode} to Object instances, which means:
If left undefined the JavaScript representation of these layouts will be Object instances.
Replicate the layout using a new property.
This function must be used to get a structurally-equivalent layout with a different name since all Layout instances are immutable.
NOTE This is a shallow copy. All fields except {@link Layout#property|property} are strictly equal to the origin layout.
the value for {@link Layout#property|property} in the replica.
property.Generated using TypeDoc
Represent an unsigned integer in little-endian format.
Factory: {@link module:Layout.u8|u8}, {@link module:Layout.u16|u16}, {@link module:Layout.u24|u24}, {@link module:Layout.u32|u32}, {@link module:Layout.u40|u40}, {@link module:Layout.u48|u48}
initializer for {@link Layout#span|span}. The parameter can range from 1 through 6.
initializer for {@link Layout#property|property}.