Skip to main content

BlobPlane

Struct BlobPlane 

Source
pub struct BlobPlane<'a> {
    pub handle: i64,
    pub offset: u64,
    pub stride: u64,
    pub size: u64,
    pub used: u64,
    pub modifier: u64,
    pub handle_bytes: &'a [u8],
    pub data: &'a [u8],
}
Expand description

One plane record, borrowed from the buffer.

Field names and widths mirror TensorPlane.msg so the two map 1:1. All scalars are 64-bit, and handle is i64 rather than an fd-sized i32: cheap now, and the alternative breaks the round-trip property, since a u32 size would cap a plane at 4 GiB — which camera frames never reach but a tensor carrying model weights plausibly does.

The two transport modes are distinguished by handle:

  • handle >= 0 — reference: the bytes live behind the handle, and data is empty.
  • handle == -1 — inline: the bytes are in data, offset is ignored, size describes data, and modifier must be 0.

Fields§

§handle: i64

In reference mode, an INDEX into the accompanying fd table — not a raw file descriptor. -1 when inline.

This is an ABI decision, not an implementation detail. A raw fd is meaningless in the receiving process: fds travel out of band via SCM_RIGHTS or pidfd_getfd, and the receiver is handed different numbers than the sender used. Wayland, D-Bus and CameraFrame all carry the same (payload, fds) split for the same reason.

Indices also let planes share a descriptor: NV12’s luma and chroma commonly live in one dma-buf at different offsets, and both planes then carry index 0 while the table holds a single fd.

Windows has no fd table: a D3D11 texture is shared by NT handle, which is a value in the exporting process’s handle table rather than a descriptor an out-of-band table can carry. Such a plane carries index 0 over an empty table — non-negative, so the record is still a reference and not an inline one — and its handles live in Self::handle_bytes.

§offset: u64

Byte offset of this plane within the handle; ignored when inline.

§stride: u64

Bytes per line of this plane.

§size: u64

Plane capacity in bytes.

§used: u64

Valid payload bytes; used <= size.

§modifier: u64

DRM format modifier. 0 = linear. A consumer that does not recognise a non-zero value must refuse, not read the plane as linear.

§handle_bytes: &'a [u8]

Opaque handle for backends whose handle is not an integer (a cudaIpcMemHandle_t is 64 bytes), or whose handle does not travel in the fd table at all.

Windows D3D11 textures are the one storage kind that fills this in today: D3D11_HANDLE_BYTES bytes holding the texture’s NT handle value, the process device fence’s NT handle value and the fence value of the producer’s last recorded GPU write, each a little-endian u64. All three are values in the exporting process’s handle table, which is why the header’s BlobHeader::pid is what makes them reachable – and why that field documents the trust boundary they share.

§data: &'a [u8]

Inlined plane bytes; non-empty only when handle == -1.

Implementations§

Source§

impl BlobPlane<'_>

Source

pub fn is_inline(&self) -> bool

True when this plane carries its bytes rather than a reference to them.

Source

pub fn encoded_len(&self) -> usize

Encoded length of this record, including the padding that keeps the following record 8-aligned.

Trait Implementations§

Source§

impl<'a> Clone for BlobPlane<'a>

Source§

fn clone(&self) -> BlobPlane<'a>

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<'a> Copy for BlobPlane<'a>

Source§

impl<'a> Debug for BlobPlane<'a>

Source§

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

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

impl<'a> Eq for BlobPlane<'a>

Source§

impl<'a> PartialEq for BlobPlane<'a>

Source§

fn eq(&self, other: &BlobPlane<'a>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for BlobPlane<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for BlobPlane<'a>

§

impl<'a> RefUnwindSafe for BlobPlane<'a>

§

impl<'a> Send for BlobPlane<'a>

§

impl<'a> Sync for BlobPlane<'a>

§

impl<'a> Unpin for BlobPlane<'a>

§

impl<'a> UnsafeUnpin for BlobPlane<'a>

§

impl<'a> UnwindSafe for BlobPlane<'a>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more