#[non_exhaustive]pub enum TensorDyn {
U8(Tensor<u8>),
I8(Tensor<i8>),
U16(Tensor<u16>),
I16(Tensor<i16>),
U32(Tensor<u32>),
I32(Tensor<i32>),
U64(Tensor<u64>),
I64(Tensor<i64>),
F16(Tensor<f16>),
F32(Tensor<f32>),
F64(Tensor<f64>),
}Expand description
Type-erased tensor. Wraps a Tensor<T> with runtime element type.
Variants (Non-exhaustive)§
This enum is marked as non-exhaustive
U8(Tensor<u8>)
Unsigned 8-bit integer tensor.
I8(Tensor<i8>)
Signed 8-bit integer tensor.
U16(Tensor<u16>)
Unsigned 16-bit integer tensor.
I16(Tensor<i16>)
Signed 16-bit integer tensor.
U32(Tensor<u32>)
Unsigned 32-bit integer tensor.
I32(Tensor<i32>)
Signed 32-bit integer tensor.
U64(Tensor<u64>)
Unsigned 64-bit integer tensor.
I64(Tensor<i64>)
Signed 64-bit integer tensor.
F16(Tensor<f16>)
16-bit floating-point tensor.
F32(Tensor<f32>)
32-bit floating-point tensor.
F64(Tensor<f64>)
64-bit floating-point tensor.
Implementations§
Source§impl TensorDyn
impl TensorDyn
Sourcepub fn format(&self) -> Option<PixelFormat>
pub fn format(&self) -> Option<PixelFormat>
Return the pixel format (None if not an image tensor).
Sourcepub fn memory(&self) -> TensorMemory
pub fn memory(&self) -> TensorMemory
Return the memory allocation type.
Sourcepub fn reshape(&mut self, shape: &[usize]) -> Result<()>
pub fn reshape(&mut self, shape: &[usize]) -> Result<()>
Reshape this tensor. Total element count must remain the same.
Sourcepub fn set_format(&mut self, format: PixelFormat) -> Result<()>
pub fn set_format(&mut self, format: PixelFormat) -> Result<()>
Attach pixel format metadata to this tensor.
Validates that the tensor’s shape is compatible with the format’s layout (packed, planar, or semi-planar).
§Arguments
format- The pixel format to attach
§Returns
Ok(()) on success, with the format stored as metadata on the tensor.
§Errors
Returns Error::InvalidShape if the tensor shape doesn’t match
the expected layout for the given format.
Sourcepub fn with_format(self, format: PixelFormat) -> Result<Self>
pub fn with_format(self, format: PixelFormat) -> Result<Self>
Attach pixel format metadata, consuming and returning self.
Enables builder-style chaining.
§Arguments
format- The pixel format to attach
§Returns
The tensor with format metadata attached.
§Errors
Returns Error::InvalidShape if the tensor shape doesn’t match
the expected layout for the given format.
Sourcepub fn row_stride(&self) -> Option<usize>
pub fn row_stride(&self) -> Option<usize>
Row stride in bytes (None = tightly packed).
Sourcepub fn effective_row_stride(&self) -> Option<usize>
pub fn effective_row_stride(&self) -> Option<usize>
Effective row stride: stored stride or computed from format and width.
Sourcepub fn set_row_stride(&mut self, stride: usize) -> Result<()>
pub fn set_row_stride(&mut self, stride: usize) -> Result<()>
Set the row stride in bytes for externally allocated buffers with row padding.
Must be called before the tensor is first used for rendering. The format must be set before calling this method.
Sourcepub fn with_row_stride(self, stride: usize) -> Result<Self>
pub fn with_row_stride(self, stride: usize) -> Result<Self>
Builder-style: set row stride, consuming and returning self.
Sourcepub fn plane_offset(&self) -> Option<usize>
pub fn plane_offset(&self) -> Option<usize>
Byte offset within the DMA-BUF where image data starts (None = 0).
Sourcepub fn set_plane_offset(&mut self, offset: usize)
pub fn set_plane_offset(&mut self, offset: usize)
Set the byte offset within the DMA-BUF where image data starts.
Sourcepub fn with_plane_offset(self, offset: usize) -> Self
pub fn with_plane_offset(self, offset: usize) -> Self
Builder-style: set plane offset, consuming and returning self.
Sourcepub fn clone_fd(&self) -> Result<OwnedFd>
pub fn clone_fd(&self) -> Result<OwnedFd>
Clone the file descriptor associated with this tensor.
Sourcepub fn dmabuf_clone(&self) -> Result<OwnedFd>
pub fn dmabuf_clone(&self) -> Result<OwnedFd>
Sourcepub fn dmabuf(&self) -> Result<BorrowedFd<'_>>
pub fn dmabuf(&self) -> Result<BorrowedFd<'_>>
Sourcepub fn is_multiplane(&self) -> bool
pub fn is_multiplane(&self) -> bool
Return true if this tensor uses separate plane allocations.
Sourcepub fn as_u8(&self) -> Option<&Tensor<u8>>
pub fn as_u8(&self) -> Option<&Tensor<u8>>
Returns a shared reference to the inner tensor if the type matches.
Sourcepub fn as_u8_mut(&mut self) -> Option<&mut Tensor<u8>>
pub fn as_u8_mut(&mut self) -> Option<&mut Tensor<u8>>
Returns a mutable reference to the inner tensor if the type matches.
Sourcepub fn into_u8(self) -> Result<Tensor<u8>, Self>
pub fn into_u8(self) -> Result<Tensor<u8>, Self>
Unwraps the inner tensor if the type matches, otherwise returns self as Err.
The Err variant is necessarily large (returns the unconsumed TensorDyn).
Sourcepub fn as_i8(&self) -> Option<&Tensor<i8>>
pub fn as_i8(&self) -> Option<&Tensor<i8>>
Returns a shared reference to the inner tensor if the type matches.
Sourcepub fn as_i8_mut(&mut self) -> Option<&mut Tensor<i8>>
pub fn as_i8_mut(&mut self) -> Option<&mut Tensor<i8>>
Returns a mutable reference to the inner tensor if the type matches.
Sourcepub fn into_i8(self) -> Result<Tensor<i8>, Self>
pub fn into_i8(self) -> Result<Tensor<i8>, Self>
Unwraps the inner tensor if the type matches, otherwise returns self as Err.
The Err variant is necessarily large (returns the unconsumed TensorDyn).
Sourcepub fn as_u16(&self) -> Option<&Tensor<u16>>
pub fn as_u16(&self) -> Option<&Tensor<u16>>
Returns a shared reference to the inner tensor if the type matches.
Sourcepub fn as_u16_mut(&mut self) -> Option<&mut Tensor<u16>>
pub fn as_u16_mut(&mut self) -> Option<&mut Tensor<u16>>
Returns a mutable reference to the inner tensor if the type matches.
Sourcepub fn into_u16(self) -> Result<Tensor<u16>, Self>
pub fn into_u16(self) -> Result<Tensor<u16>, Self>
Unwraps the inner tensor if the type matches, otherwise returns self as Err.
The Err variant is necessarily large (returns the unconsumed TensorDyn).
Sourcepub fn as_i16(&self) -> Option<&Tensor<i16>>
pub fn as_i16(&self) -> Option<&Tensor<i16>>
Returns a shared reference to the inner tensor if the type matches.
Sourcepub fn as_i16_mut(&mut self) -> Option<&mut Tensor<i16>>
pub fn as_i16_mut(&mut self) -> Option<&mut Tensor<i16>>
Returns a mutable reference to the inner tensor if the type matches.
Sourcepub fn into_i16(self) -> Result<Tensor<i16>, Self>
pub fn into_i16(self) -> Result<Tensor<i16>, Self>
Unwraps the inner tensor if the type matches, otherwise returns self as Err.
The Err variant is necessarily large (returns the unconsumed TensorDyn).
Sourcepub fn as_u32(&self) -> Option<&Tensor<u32>>
pub fn as_u32(&self) -> Option<&Tensor<u32>>
Returns a shared reference to the inner tensor if the type matches.
Sourcepub fn as_u32_mut(&mut self) -> Option<&mut Tensor<u32>>
pub fn as_u32_mut(&mut self) -> Option<&mut Tensor<u32>>
Returns a mutable reference to the inner tensor if the type matches.
Sourcepub fn into_u32(self) -> Result<Tensor<u32>, Self>
pub fn into_u32(self) -> Result<Tensor<u32>, Self>
Unwraps the inner tensor if the type matches, otherwise returns self as Err.
The Err variant is necessarily large (returns the unconsumed TensorDyn).
Sourcepub fn as_i32(&self) -> Option<&Tensor<i32>>
pub fn as_i32(&self) -> Option<&Tensor<i32>>
Returns a shared reference to the inner tensor if the type matches.
Sourcepub fn as_i32_mut(&mut self) -> Option<&mut Tensor<i32>>
pub fn as_i32_mut(&mut self) -> Option<&mut Tensor<i32>>
Returns a mutable reference to the inner tensor if the type matches.
Sourcepub fn into_i32(self) -> Result<Tensor<i32>, Self>
pub fn into_i32(self) -> Result<Tensor<i32>, Self>
Unwraps the inner tensor if the type matches, otherwise returns self as Err.
The Err variant is necessarily large (returns the unconsumed TensorDyn).
Sourcepub fn as_u64(&self) -> Option<&Tensor<u64>>
pub fn as_u64(&self) -> Option<&Tensor<u64>>
Returns a shared reference to the inner tensor if the type matches.
Sourcepub fn as_u64_mut(&mut self) -> Option<&mut Tensor<u64>>
pub fn as_u64_mut(&mut self) -> Option<&mut Tensor<u64>>
Returns a mutable reference to the inner tensor if the type matches.
Sourcepub fn into_u64(self) -> Result<Tensor<u64>, Self>
pub fn into_u64(self) -> Result<Tensor<u64>, Self>
Unwraps the inner tensor if the type matches, otherwise returns self as Err.
The Err variant is necessarily large (returns the unconsumed TensorDyn).
Sourcepub fn as_i64(&self) -> Option<&Tensor<i64>>
pub fn as_i64(&self) -> Option<&Tensor<i64>>
Returns a shared reference to the inner tensor if the type matches.
Sourcepub fn as_i64_mut(&mut self) -> Option<&mut Tensor<i64>>
pub fn as_i64_mut(&mut self) -> Option<&mut Tensor<i64>>
Returns a mutable reference to the inner tensor if the type matches.
Sourcepub fn into_i64(self) -> Result<Tensor<i64>, Self>
pub fn into_i64(self) -> Result<Tensor<i64>, Self>
Unwraps the inner tensor if the type matches, otherwise returns self as Err.
The Err variant is necessarily large (returns the unconsumed TensorDyn).
Sourcepub fn as_f16(&self) -> Option<&Tensor<f16>>
pub fn as_f16(&self) -> Option<&Tensor<f16>>
Returns a shared reference to the inner tensor if the type matches.
Sourcepub fn as_f16_mut(&mut self) -> Option<&mut Tensor<f16>>
pub fn as_f16_mut(&mut self) -> Option<&mut Tensor<f16>>
Returns a mutable reference to the inner tensor if the type matches.
Sourcepub fn into_f16(self) -> Result<Tensor<f16>, Self>
pub fn into_f16(self) -> Result<Tensor<f16>, Self>
Unwraps the inner tensor if the type matches, otherwise returns self as Err.
The Err variant is necessarily large (returns the unconsumed TensorDyn).
Sourcepub fn as_f32(&self) -> Option<&Tensor<f32>>
pub fn as_f32(&self) -> Option<&Tensor<f32>>
Returns a shared reference to the inner tensor if the type matches.
Sourcepub fn as_f32_mut(&mut self) -> Option<&mut Tensor<f32>>
pub fn as_f32_mut(&mut self) -> Option<&mut Tensor<f32>>
Returns a mutable reference to the inner tensor if the type matches.
Sourcepub fn into_f32(self) -> Result<Tensor<f32>, Self>
pub fn into_f32(self) -> Result<Tensor<f32>, Self>
Unwraps the inner tensor if the type matches, otherwise returns self as Err.
The Err variant is necessarily large (returns the unconsumed TensorDyn).
Sourcepub fn as_f64(&self) -> Option<&Tensor<f64>>
pub fn as_f64(&self) -> Option<&Tensor<f64>>
Returns a shared reference to the inner tensor if the type matches.
Sourcepub fn as_f64_mut(&mut self) -> Option<&mut Tensor<f64>>
pub fn as_f64_mut(&mut self) -> Option<&mut Tensor<f64>>
Returns a mutable reference to the inner tensor if the type matches.
Sourcepub fn into_f64(self) -> Result<Tensor<f64>, Self>
pub fn into_f64(self) -> Result<Tensor<f64>, Self>
Unwraps the inner tensor if the type matches, otherwise returns self as Err.
The Err variant is necessarily large (returns the unconsumed TensorDyn).
Sourcepub fn new(
shape: &[usize],
dtype: DType,
memory: Option<TensorMemory>,
name: Option<&str>,
) -> Result<Self>
pub fn new( shape: &[usize], dtype: DType, memory: Option<TensorMemory>, name: Option<&str>, ) -> Result<Self>
Create a type-erased tensor with the given shape and element type.
Sourcepub fn from_fd(
fd: OwnedFd,
shape: &[usize],
dtype: DType,
name: Option<&str>,
) -> Result<Self>
pub fn from_fd( fd: OwnedFd, shape: &[usize], dtype: DType, name: Option<&str>, ) -> Result<Self>
Create a type-erased tensor from a file descriptor.
Sourcepub fn image(
width: usize,
height: usize,
format: PixelFormat,
dtype: DType,
memory: Option<TensorMemory>,
) -> Result<Self>
pub fn image( width: usize, height: usize, format: PixelFormat, dtype: DType, memory: Option<TensorMemory>, ) -> Result<Self>
Create a type-erased image tensor.
§Arguments
width- Image width in pixelsheight- Image height in pixelsformat- Pixel formatdtype- Element type discriminantmemory- Optional memory backend (None selects the best available)
§Returns
A new TensorDyn wrapping an image tensor of the requested element type.
§Errors
Returns an error if the underlying Tensor::image call fails.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for TensorDyn
impl !RefUnwindSafe for TensorDyn
impl Send for TensorDyn
impl Sync for TensorDyn
impl Unpin for TensorDyn
impl UnsafeUnpin for TensorDyn
impl !UnwindSafe for TensorDyn
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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