Skip to main content

HurrayCompositeNode

Struct HurrayCompositeNode 

Source
#[repr(C)]
pub struct HurrayCompositeNode { pub kind: u8, pub name: *const u8, pub name_len: usize, pub descriptor: *const HurrayDescriptor, pub payloads: *const HurrayIoSlice, pub payload_count: usize, pub member_count: u32, }
Expand description

One node of a composite to write: a tensor member, or a head whose members follow it.

A flat tagged struct rather than a union, for the reason HurrayKvValue is one: every binding generator downstream of this header reads a struct correctly and few read a union well. Fields the kind does not select are ignored.

Every pointer borrows from the caller and MUST stay valid and unmodified until the write call returns. Nothing here is copied — not the descriptors, and above all not the payloads (ADR-041 § 3).

Fields§

§kind: u8§name: *const u8

First byte of this node’s tensor name, UTF-8 and not NUL-terminated.

Required on the file surface, where every tensor — head and member alike — gets its own footer-index entry. Ignored on the stream surface, which carries no names.

§name_len: usize

Byte length of name.

§descriptor: *const HurrayDescriptor

The node’s descriptor: a member’s tensor descriptor, or a head’s composite one.

§payloads: *const HurrayIoSlice

One slice per buffer handle in descriptor’s buffer table, in that order.

Ignored for a composite node: a head owns no data buffers, which its descriptor already states — and a head whose descriptor says otherwise is refused by the validator, not here.

§payload_count: usize

Number of slices at payloads.

§member_count: u32

How many of the nodes following this one are its direct members. 0 for a tensor.

Trait Implementations§

Source§

impl Clone for HurrayCompositeNode

Source§

fn clone(&self) -> HurrayCompositeNode

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 Copy for HurrayCompositeNode

Source§

impl Default for HurrayCompositeNode

Source§

fn default() -> Self

A zeroed node, which is what a C caller gets from {0}.

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.