Struct CompositeLayout 

#[non_exhaustive]
pub struct CompositeLayout {
    pub rule: CompositionRule,
    pub member_count: u32,
}

The composite head’s layout-specific payload (spec § Head Layout-Specific Fields).

Carried by crate::layout::LayoutDescriptor::Composite. See docs/spec/layouts/composite.md and crate::composite for the full head + members model and cross-member validation.

Examples

use hurray_core::layout::{CompositeLayout, CompositionRule, LayoutDescriptor};

let layout = CompositeLayout::new(CompositionRule::Partition, 2).unwrap();
let desc = LayoutDescriptor::Composite(layout);
assert_eq!(desc.tag(), 0x0B);
assert!(desc.buffer_count().is_none()); // "known zero" isn't NonZeroU8-representable
assert!(desc.is_virtual());

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

rule: CompositionRule

The composition rule (composition_rule + combine_op wire fields).

member_count: u32

Number of member tensors that immediately follow the head. A definite count for every v1.0 composition rule; 0xFFFFFFFF (open composite) is RESERVED.

Implementations

impl CompositeLayout

pub fn new(rule: CompositionRule, member_count: u32) -> Result<Self>

Creates a new CompositeLayout.

Errors

Returns Error::OpenCompositeReserved if member_count == 0xFFFFFFFF (the open-composite sentinel, RESERVED and not usable in v1.0).

Examples

use hurray_core::layout::{CompositeLayout, CompositionRule};

let ok = CompositeLayout::new(CompositionRule::Group, 3).unwrap();
assert_eq!(ok.member_count, 3);

// The open-composite sentinel is reserved in v1.0.
assert!(CompositeLayout::new(CompositionRule::Partition, 0xFFFF_FFFF).is_err());

Trait Implementations

impl Clone for CompositeLayout

fn clone(&self) -> CompositeLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompositeLayout

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

Formats the value using the given formatter.

impl Eq for CompositeLayout

impl Hash for CompositeLayout

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CompositeLayout

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CompositeLayout