Struct IValue

#[repr(C)]
pub struct IValue { /* private fields */ }

Rust binding for the C++ type c10::IValue.

IValue is a tagged union type that can hold any input to a PyTorch operator. See IValueKind for the list of supported types.

Safety

IValue either contains Copy-able data or a Tensor-like object, so it inherits the safety properties of Tensor. See the safety discussion in Tensor for more info.

Implementations

impl IValue

pub fn dump(&self)

Prints a human-readable representation of the IValue to stdout.

impl IValue

pub fn to_tensor(self) -> Option<Tensor>

pub fn to_string(&self) -> Option<String>

pub fn to_int_list(&self) -> Option<Vec<i64>>

pub fn to_int(&self) -> Option<i64>

pub fn to_double(&self) -> Option<f64>

pub fn to_bool(&self) -> Option<bool>

pub fn to_tensor_list(self) -> Option<Vec<Tensor>>

pub fn to_device(&self) -> Option<Device>

pub fn to_none(&self) -> Option<()>

pub fn to_opaque(self) -> Option<OpaqueIValue>

pub fn is_tensor(&self) -> bool

pub fn is_string(&self) -> bool

pub fn is_int_list(&self) -> bool

pub fn is_int(&self) -> bool

pub fn is_double(&self) -> bool

pub fn is_bool(&self) -> bool

pub fn is_tensor_list(&self) -> bool

pub fn is_device(&self) -> bool

pub fn is_none(&self) -> bool

pub fn is_other(&self) -> bool

pub fn kind(&self) -> IValueKind

pub fn from_py_object_with_type( obj: Bound<'_, PyAny>, type_: &TypePtr, num_elements: i32, allow_nums_as_tensors: bool, ) -> PyResult<IValue>

Trait Implementations

impl CloneUnsafe for IValue

unsafe fn clone_unsafe(&self) -> Self

This is unsafe, it creates an alias of the underlying data that is not tracked by Rust. We use this to interface with C++ functions that expect an owned IValue.

The contract for calling this function is that the clone is local and ephemeral. More precisely:

1. The clone must not be sent to another thread (local).
2. You must guarantee that clone is dropped before the originating mutable reference is dropped (ephemeral).

impl Debug for IValue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IValue

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for IValue

fn drop(&mut self)

Executes the destructor for this type.

impl ExternType for IValue

type Id = (c, _1, _0, (), I, V, a, l, u, e)

A type-level representation of the type’s C++ namespace and type name.

type Kind = Trivial

Either cxx::kind::Opaque or cxx::kind::Trivial.

impl From<&[i64]> for IValue

fn from(value: &[i64]) -> Self

Converts to this type from the input type.

impl From<&String> for IValue

fn from(value: &String) -> Self

Converts to this type from the input type.

impl From<()> for IValue

fn from(_value: ()) -> Self

Converts to this type from the input type.

impl From<Device> for IValue

fn from(value: Device) -> Self

Converts to this type from the input type.

impl From<IValue> for RValue

fn from(ivalue: IValue) -> Self

Converts to this type from the input type.

impl From<Tensor> for IValue

fn from(value: Tensor) -> Self

Converts to this type from the input type.

impl From<Vec<Tensor>> for IValue

fn from(value: Vec<Tensor>) -> Self

Converts to this type from the input type.

impl From<bool> for IValue

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f64> for IValue

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i64> for IValue

fn from(value: i64) -> Self

Converts to this type from the input type.

impl FromPyObject<'_> for IValue

fn extract_bound(obj: &Bound<'_, PyAny>) -> PyResult<Self>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for IValue

type Target = PyAny

The Python output type

type Output = Bound<'py, <IValue as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject(self, py: Python<'py>) -> Result<Self::Output, Self::Error>

Performs the conversion.

impl PartialEq for IValue

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for IValue

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Send for IValue

SAFETY: IValue is Send, it is either a copyable type or atomically refcounted via c10::intrusive_ptr.

impl Sync for IValue

SAFETY: IValue is Sync, due to safety in exposing any of the interior mutability of the payload it holds. The value is converted to native types like Tensor for use in rust or left opaque. See OpaqueIValue for more details.