Skip to main content

CreateRelation

Struct CreateRelation 

Source
pub struct CreateRelation<'a> {
Show 13 fields pub id: Id, pub relation_type: Id, pub from: Id, pub from_is_value_ref: bool, pub from_space: Option<Id>, pub from_version: Option<Id>, pub to: Id, pub to_is_value_ref: bool, pub to_space: Option<Id>, pub to_version: Option<Id>, pub entity: Option<Id>, pub position: Option<Cow<'a, str>>, pub context: Option<Context>,
}
Expand description

Creates a new relation (spec Section 3.3).

Also implicitly creates the reified entity if it doesn’t exist.

Fields§

§id: Id

The relation’s unique identifier.

§relation_type: Id

The relation type entity ID.

§from: Id

Source entity or value ref ID.

§from_is_value_ref: bool

If true, from is a value ref ID (inline encoding). If false, from is an entity ID (ObjectRef encoding).

§from_space: Option<Id>

Optional space pin for source entity.

§from_version: Option<Id>

Optional version (edit ID) to pin source entity.

§to: Id

Target entity or value ref ID.

§to_is_value_ref: bool

If true, to is a value ref ID (inline encoding). If false, to is an entity ID (ObjectRef encoding).

§to_space: Option<Id>

Optional space pin for target entity.

§to_version: Option<Id>

Optional version (edit ID) to pin target entity.

§entity: Option<Id>

Explicit reified entity ID. If None, entity ID is auto-derived from the relation ID.

§position: Option<Cow<'a, str>>

Optional ordering position (fractional indexing).

§context: Option<Context>

Optional context for grouping changes (spec Section 4.5).

Implementations§

Source§

impl CreateRelation<'_>

Source

pub fn entity_id(&self) -> Id

Computes the reified entity ID.

If explicit entity is provided, returns it. Otherwise, derives it from the relation ID.

Source

pub fn has_explicit_entity(&self) -> bool

Returns true if this relation has an explicit entity ID.

Trait Implementations§

Source§

impl<'a> Clone for CreateRelation<'a>

Source§

fn clone(&self) -> CreateRelation<'a>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for CreateRelation<'a>

Source§

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

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

impl<'a> PartialEq for CreateRelation<'a>

Source§

fn eq(&self, other: &CreateRelation<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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<'a> StructuralPartialEq for CreateRelation<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for CreateRelation<'a>

§

impl<'a> RefUnwindSafe for CreateRelation<'a>

§

impl<'a> Send for CreateRelation<'a>

§

impl<'a> Sync for CreateRelation<'a>

§

impl<'a> Unpin for CreateRelation<'a>

§

impl<'a> UnwindSafe for CreateRelation<'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<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> Same for T

Source§

type Output = T

Should always be Self
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.