Edge

Struct Edge 

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

Represents a edge from an ent to one or more other ents

Implementations§

Source§

impl Edge

Source

pub fn new<N: Into<String>, V: Into<EdgeValue>>(name: N, value: V) -> Self

Creates a new edge with the given name, value, and deletion policy of nothing

§Examples
use entity::{Edge, EdgeDeletionPolicy};

let edge = Edge::new("edge1", 999);
assert_eq!(edge.name(), "edge1");
assert_eq!(edge.to_ids(), vec![999]);
assert_eq!(edge.deletion_policy(), EdgeDeletionPolicy::Nothing);
Source

pub fn new_with_deletion_policy<N: Into<String>, V: Into<EdgeValue>>( name: N, value: V, deletion_policy: EdgeDeletionPolicy, ) -> Self

Creates a new edge with the given name, value, and deletion policy

§Examples
use entity::{Edge, EdgeDeletionPolicy};

let edge = Edge::new_with_deletion_policy(
    "edge1",
    999,
    EdgeDeletionPolicy::DeepDelete,
);
assert_eq!(edge.name(), "edge1");
assert_eq!(edge.to_ids(), vec![999]);
assert_eq!(edge.deletion_policy(), EdgeDeletionPolicy::DeepDelete);
Source

pub fn name(&self) -> &str

The name of the edge

Source

pub fn value(&self) -> &EdgeValue

The value of the edge

Source

pub fn value_mut(&mut self) -> &mut EdgeValue

The mutable value of the edge

Source

pub fn into_value(self) -> EdgeValue

Converts edge into its value

Source

pub fn to_ids(&self) -> Vec<Id>

Converts to the ids of the ents referenced by this edge

Source

pub fn to_type(&self) -> EdgeValueType

Converts to the edge’s value type

Source

pub fn deletion_policy(&self) -> EdgeDeletionPolicy

Returns the policy to perform for this edge when its ent is deleted

Source

pub fn has_no_deletion_policy(&self) -> bool

Returns true if the deletion policy is nothing

Source

pub fn has_shallow_deletion_policy(&self) -> bool

Returns true if the deletion policy is shallow

Source

pub fn has_deep_deletion_policy(&self) -> bool

Returns true if the deletion policy is deep

Trait Implementations§

Source§

impl Clone for Edge

Source§

fn clone(&self) -> Edge

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

Source§

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

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

impl<'a> From<&'a Edge> for EdgeDefinition

Source§

fn from(edge: &'a Edge) -> Self

Converts to this type from the input type.
Source§

impl From<Edge> for EdgeDefinition

Source§

fn from(edge: Edge) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Edge

Source§

fn eq(&self, other: &Edge) -> 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 Eq for Edge

Source§

impl StructuralPartialEq for Edge

Auto Trait Implementations§

§

impl Freeze for Edge

§

impl RefUnwindSafe for Edge

§

impl Send for Edge

§

impl Sync for Edge

§

impl Unpin for Edge

§

impl UnwindSafe for Edge

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> AsAny for T
where T: 'static,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts reference to Any
Source§

fn as_mut_any(&mut self) -> &mut (dyn Any + 'static)

converts mutable reference to Any
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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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.