Skip to main content

EntityBuilder

Struct EntityBuilder 

Source
pub struct EntityBuilder<'a> { /* private fields */ }
Expand description

A partially-specified entity, checked against the schema on build.

Implementations§

Source§

impl<'a> EntityBuilder<'a>

Source

pub fn new(schema: &'a Schema, entity: impl Into<String>) -> Self

Start building entity, whose type must be declared by schema.

The type is not checked here: an unknown type is reported by build, so that a caller assembling several entities gets every failure at the same point in its code rather than some at construction and some later.

Source

pub fn set(self, attribute: impl Into<String>, value: Value) -> Self

Set one attribute by its declared name.

Names are matched case-insensitively, because EXPRESS declares GlobalId while STEP files and much prose write GLOBALID.

Source

pub fn text( self, attribute: impl Into<String>, text: impl Into<Arc<str>>, ) -> Self

Set a text attribute.

Source

pub fn real(self, attribute: impl Into<String>, value: f64) -> Self

Set a real-valued attribute.

Source

pub fn reference(self, attribute: impl Into<String>, id: EntityId) -> Self

Set an entity-reference attribute.

Source

pub fn enumeration( self, attribute: impl Into<String>, constant: impl Into<Arc<str>>, ) -> Self

Set an enumeration attribute (written .PLAN_VIEW. in STEP).

Source§

impl EntityBuilder<'_>

Source

pub fn build(self) -> AuthorResult<Entity>

Resolve every named attribute to its STEP slot and produce the entity.

§Errors

Refuses an unknown entity type, an attribute the schema does not declare, an attribute set twice, a required attribute left unset, a scalar/aggregate confusion, a value whose shape contradicts the declared type, and a malformed GlobalId.

Source

pub fn insert(self, model: &mut Model) -> AuthorResult<EntityId>

Build the entity and append it to model, returning its new id.

The model is left untouched when construction fails, so a rejected entity cannot leave a half-written record behind.

§Errors

Any failure from build.

Trait Implementations§

Source§

impl<'a> Clone for EntityBuilder<'a>

Source§

fn clone(&self) -> Self

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<'a> Debug for EntityBuilder<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for EntityBuilder<'a>

§

impl<'a> RefUnwindSafe for EntityBuilder<'a>

§

impl<'a> Send for EntityBuilder<'a>

§

impl<'a> Sync for EntityBuilder<'a>

§

impl<'a> Unpin for EntityBuilder<'a>

§

impl<'a> UnsafeUnpin for EntityBuilder<'a>

§

impl<'a> UnwindSafe for EntityBuilder<'a>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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.