Skip to main content

PrivateExtensionLayout

Struct PrivateExtensionLayout 

Source
#[non_exhaustive]
pub struct PrivateExtensionLayout { pub tag: u8, pub extension_layout_id: u64, pub extension_data: Vec<u8>, }
Expand description

Descriptor for an implementation-private extension layout.

Tags in 0xF0–0xFE are reserved for implementation-private layouts. Tensors using these tags MUST NOT be exchanged between independent implementations unless both parties have agreed on the layout semantics out of band.

An extension layout descriptor carries:

  • an extension_layout_id (uint64): implementation-defined unique identifier,
  • extension_data (Vec<u8>): opaque layout-specific metadata.

The Unknown variant (for unrecognized tags in permissive mode) is separate; see [UnknownLayout].

§Examples

use hurray_core::layout::{LayoutDescriptor, PrivateExtensionLayout};

let layout = LayoutDescriptor::PrivateExtension(
    PrivateExtensionLayout::new(0xF0, 0xDEAD_BEEF_CAFE_0001, vec![1, 2, 3]).unwrap(),
);
assert_eq!(layout.tag(), 0xF0);
// buffer_count is None — unknown for private layouts.
assert!(layout.buffer_count().is_none());

Fields (Non-exhaustive)§

This struct is marked as 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.
§tag: u8

The layout tag byte (0xF0–0xFE).

§extension_layout_id: u64

Implementation-defined unique identifier for this extension layout.

§extension_data: Vec<u8>

Opaque layout-specific metadata.

Implementations§

Source§

impl PrivateExtensionLayout

Source

pub fn new( tag: u8, extension_layout_id: u64, extension_data: Vec<u8>, ) -> Result<Self>

Creates a new PrivateExtensionLayout, validating that tag is in the private-extension range 0xF0–0xFE.

§Errors

Returns Error::InvalidLayout if tag is outside 0xF0–0xFE.

§Examples
use hurray_core::layout::PrivateExtensionLayout;

let p = PrivateExtensionLayout::new(0xF1, 42, vec![0xAB, 0xCD]).unwrap();
assert_eq!(p.tag, 0xF1);

// Tags outside the private range are rejected.
assert!(PrivateExtensionLayout::new(0x01, 0, vec![]).is_err());
assert!(PrivateExtensionLayout::new(0xFF, 0, vec![]).is_err());

Trait Implementations§

Source§

impl Clone for PrivateExtensionLayout

Source§

fn clone(&self) -> PrivateExtensionLayout

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 Debug for PrivateExtensionLayout

Source§

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

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

impl Eq for PrivateExtensionLayout

Source§

impl Hash for PrivateExtensionLayout

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for PrivateExtensionLayout

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for PrivateExtensionLayout

Auto Trait Implementations§

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> 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 = 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.