Skip to main content

HostWriteGuard

Struct HostWriteGuard 

Source
pub struct HostWriteGuard<'a, T> { /* private fields */ }
Expand description

Closure-scoped write-only mapping of a backend allocation.

§Examples

use tenferro_tensor::{HostAccessError, HostWriteGuard};

let mut written = Vec::new();
{
    let mut guard = HostWriteGuard::new(2, |source: &[u32]| {
        written.extend_from_slice(source);
        Ok::<(), HostAccessError>(())
    });
    guard.copy_from_slice(&[4, 5]).unwrap();
}
assert_eq!(written, [4, 5]);

Implementations§

Source§

impl<'a, T> HostWriteGuard<'a, T>

Source

pub fn new<F>(len: usize, copy: F) -> Self
where F: FnMut(&[T]) -> Result<(), HostAccessError> + 'a, T: 'a,

Wrap a backend-native write guard without exposing its concrete type.

§Examples
use tenferro_tensor::{HostAccessError, HostWriteGuard};

let guard = HostWriteGuard::new(0, |_source: &[f32]| Ok::<(), HostAccessError>(()));
assert!(guard.is_empty());
§Errors

Construction is infallible. A callback failure such as HostAccessError::BackendFailure is returned later by Self::copy_from_slice.

Source

pub fn len(&self) -> usize

Number of elements covered by this write-only mapping.

§Examples
use tenferro_tensor::{HostAccessError, HostWriteGuard};

let guard = HostWriteGuard::new(2, |_source: &[f32]| Ok::<(), HostAccessError>(()));
assert_eq!(guard.len(), 2);
Source

pub fn is_empty(&self) -> bool

Returns true when this mapping covers no elements.

§Examples
use tenferro_tensor::{HostAccessError, HostWriteGuard};

let guard = HostWriteGuard::new(0, |_source: &[f32]| Ok::<(), HostAccessError>(()));
assert!(guard.is_empty());
Source

pub fn copy_from_slice(&mut self, source: &[T]) -> Result<(), HostAccessError>

Replace the full mapped allocation contents.

§Examples
use tenferro_tensor::{HostAccessError, HostWriteGuard};

let mut guard = HostWriteGuard::new(1, |_source: &[f32]| Ok::<(), HostAccessError>(()));
guard.copy_from_slice(&[1.0]).unwrap();
§Errors

Returns HostAccessError::LengthMismatch when source does not cover the complete mapping, or the typed backend error returned by the owning write guard.

Trait Implementations§

Source§

impl<T> Debug for HostWriteGuard<'_, T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, T> Freeze for HostWriteGuard<'a, T>

§

impl<'a, T> !RefUnwindSafe for HostWriteGuard<'a, T>

§

impl<'a, T> !Send for HostWriteGuard<'a, T>

§

impl<'a, T> !Sync for HostWriteGuard<'a, T>

§

impl<'a, T> Unpin for HostWriteGuard<'a, T>

§

impl<'a, T> UnsafeUnpin for HostWriteGuard<'a, T>

§

impl<'a, T> !UnwindSafe for HostWriteGuard<'a, T>

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

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.