Skip to main content

PlaneDescriptor

Struct PlaneDescriptor 

Source
pub struct PlaneDescriptor { /* private fields */ }
Expand description

Per-plane DMA-BUF descriptor for external buffer import.

Owns a duplicated file descriptor plus optional stride and offset metadata. The fd is duplicated eagerly in new() so that a bad fd is caught immediately. import_image consumes the descriptor and takes ownership of the duped fd — no further cleanup is needed by the caller.

§Examples

use edgefirst_tensor::PlaneDescriptor;
use std::os::fd::BorrowedFd;

// SAFETY: fd 42 is hypothetical; real code must pass a valid fd.
let pd = unsafe { PlaneDescriptor::new(BorrowedFd::borrow_raw(42)) }
    .unwrap()
    .with_stride(2048)
    .with_offset(0);

Implementations§

Source§

impl PlaneDescriptor

Source

pub fn new(fd: BorrowedFd<'_>) -> Result<Self>

Create a new plane descriptor by duplicating the given file descriptor.

The fd is duped immediately — a bad fd fails here rather than inside import_image. The caller retains ownership of the original fd.

§Errors

Returns an error if the dup() syscall fails (e.g. invalid fd or fd limit reached).

Source

pub fn with_stride(self, stride: usize) -> Self

Set the row stride in bytes (consuming builder).

Source

pub fn with_offset(self, offset: usize) -> Self

Set the plane offset in bytes (consuming builder).

Source

pub fn into_fd(self) -> OwnedFd

Consume the descriptor and return the owned file descriptor.

Source

pub fn stride(&self) -> Option<usize>

Row stride in bytes, if set.

Source

pub fn offset(&self) -> Option<usize>

Plane offset in bytes, if set.

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