Struct HostPin 

pub struct HostPin<'a> { /* private fields */ }

A stable host address for a tensor’s data, valid until the pin is dropped.

Deliberately carries no lifetime parameter and no reference to the tensor: see the module docs. Cloning is cheap and shares the keepalive.

Implementations

impl<'a> HostPin<'a>

pub fn as_ptr(&self) -> *const u8

The pinned host address. Stable until this pin is dropped.

pub fn as_mut_ptr(&self) -> *mut u8

The pinned host address, mutable.

Takes &self rather than &mut self on purpose: a raw pointer handed out here can legitimately coexist with a &mut derived elsewhere (that is the entire point of the pin), so pretending exclusivity via &mut self would be a lie. Writing through it is the caller’s obligation to sequence — see crate::Tensor::sync_for_cpu.

Safety contract

The caller must not write while a device may be reading, and must bracket CPU access with the sync calls on non-coherent backends.

pub fn len(&self) -> usize

The tensor’s logical byte length, offset-adjusted for sub-region views — not the backing allocation’s capacity.

Backends round allocations up (page size, pitch alignment), and every backend reports the logical length so a consumer cannot mistake padding for data. This is what TFLite’s SetCustomAllocationForTensor wants.

One consequence: for a stride-padded image the pinned window covers shape.product() bytes, which is less than row_stride * height. Use a map guard, which exposes the padded extent, when you need to write whole padded rows.

pub fn is_empty(&self) -> bool

True when the pinned window addresses no bytes.

pub fn alignment(&self) -> usize

Alignment of the pinned address, in bytes.

TFLite requires 64-byte alignment (kDefaultTensorAlignment) unless the caller opts out, and upstream warns that opting out can crash in Invoke(). Page-backed mappings satisfy it, but a non-zero tensor offset can break it — so callers can check rather than assume.

pub unsafe fn as_slice(&self) -> &[u8]

The pinned window as a byte slice.

Safety

The caller must ensure no device write is in flight, and must have bracketed with sync_for_cpu on non-coherent backends.

Trait Implementations

impl<'a> Clone for HostPin<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HostPin<'_>

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

Formats the value using the given formatter.

impl Send for HostPin<'_>

impl Sync for HostPin<'_>