Skip to main content

ExecutionReceipt

Struct ExecutionReceipt 

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

Account of one algorithm execution.

The requested policy is kept separately from the resolved policy so callers can distinguish an automatic CPU choice from an explicit CPU request. The transfer counters describe the explicit host/device boundary copies made by the operation; backend-specific internal work remains an implementation detail of the executing crate.

Implementations§

Source§

impl ExecutionReceipt

Source

pub fn new( requested_policy: ExecutionPolicy, resolved_policy: ExecutionPolicy, ) -> Self

Creates a receipt for a requested policy and the policy actually used.

Source

pub const fn requested_policy(&self) -> ExecutionPolicy

Returns the policy supplied by the caller.

Source

pub const fn resolved_policy(&self) -> ExecutionPolicy

Returns the backend policy selected for this execution.

Source

pub const fn transfer_stats(&self) -> TransferStats

Returns transfer accounting for this execution.

Source

pub const fn host_to_device_bytes(&self) -> u64

Returns bytes copied from host memory to a device.

Source

pub const fn device_to_device_bytes(&self) -> u64

Returns bytes copied between buffers on a device.

Source

pub const fn device_to_host_bytes(&self) -> u64

Returns bytes copied from a device back to host memory.

Source

pub fn stages(&self) -> &[&'static str]

Returns logical stages recorded by the algorithm or pipeline.

Source

pub fn record_transfer(&mut self, direction: TransferDirection, bytes: u64)

Records an explicit transfer made by the operation.

Source

pub fn record_stage(&mut self, stage: &'static str)

Records a logical stage name in execution order.

Trait Implementations§

Source§

impl Clone for ExecutionReceipt

Source§

fn clone(&self) -> ExecutionReceipt

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 Debug for ExecutionReceipt

Source§

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

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

impl Default for ExecutionReceipt

Source§

fn default() -> ExecutionReceipt

Returns the “default value” for a type. Read more
Source§

impl PartialEq for ExecutionReceipt

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Eq for ExecutionReceipt

Source§

impl StructuralPartialEq for ExecutionReceipt

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