Skip to main content

CoordinateEditor

Struct CoordinateEditor 

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

A private coordinate copy that becomes a new structure only on commit.

The original structure remains immutable and every view into it stays valid. Dropping an editor discards the transaction.

Implementations§

Source§

impl CoordinateEditor

Source

pub fn positions_mut(&mut self, model: ModelIndex) -> Option<&mut [[f32; 3]]>

Mutable positions of one dense model.

Ragged models are independent structures and must be edited through the corresponding value returned by Structure::ragged_models.

Source

pub fn try_positions_mut( &mut self, model: ModelIndex, ) -> Result<&mut [[f32; 3]], Diagnostic>

Mutable positions of one dense model, with a diagnostic on failure.

This is the fallible form for callers that must preserve molframe’s diagnostic contract across an FFI boundary.

§Errors

Returns E6003 when model is not a dense frame of this structure.

Source

pub fn commit(self) -> Result<Structure, Vec<Diagnostic>>

Validates the transaction and returns a new immutable snapshot.

§Errors

Returns every violated structural invariant. The original snapshot is unaffected whether the commit succeeds or fails.

Source

pub fn snapshot(&self) -> Result<Structure, Vec<Diagnostic>>

Builds a validated snapshot that shares the editor’s coordinate buffer.

Nothing is copied, so the snapshot and the editor see the same coordinates: use it only when the editor is not written to afterwards. A caller that keeps a writable view of the buffer must use Self::snapshot_detached.

§Errors

Returns every violated structural invariant.

Source§

impl CoordinateEditor

Source

pub fn snapshot_detached( &self, context: &ExecutionContext, ) -> Result<Structure, Vec<Diagnostic>>

Builds a validated snapshot with a coordinate buffer of its own.

The copy is charged to context’s memory budget before anything is allocated. Writing to the editor, or to a foreign view of its buffer, afterwards cannot change the published structure.

§Errors

Returns a memory diagnostic when the copy does not fit the budget, or every violated structural invariant.

Trait Implementations§

Source§

impl Debug for CoordinateEditor

Source§

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

Formats the value using the given formatter. Read more

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.