Struct entity::Edge

pub struct Edge { /* fields omitted */ }

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

Implementations

impl Edge

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);

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);

pub fn name(&self) -> &str

The name of the edge

pub fn value(&self) -> &EdgeValue

The value of the edge

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

The mutable value of the edge

pub fn into_value(self) -> EdgeValue

Converts edge into its value

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

Converts to the ids of the ents referenced by this edge

pub fn to_type(&self) -> EdgeValueType

Converts to the edge’s value type

pub fn deletion_policy(&self) -> EdgeDeletionPolicy

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

pub fn has_no_deletion_policy(&self) -> bool

Returns true if the deletion policy is nothing

pub fn has_shallow_deletion_policy(&self) -> bool

Returns true if the deletion policy is shallow

pub fn has_deep_deletion_policy(&self) -> bool

Returns true if the deletion policy is deep

Trait Implementations

impl Clone for Edge

fn clone(&self) -> Edge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Edge

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

Formats the value using the given formatter.

impl Eq for Edge

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

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

Performs the conversion.

impl From<Edge> for EdgeDefinition

fn from(edge: Edge) -> Self

Performs the conversion.

impl PartialEq<Edge> for Edge

fn eq(&self, other: &Edge) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Edge) -> bool

This method tests for !=.

impl StructuralEq for Edge

impl StructuralPartialEq for Edge