Struct edge_schema::schema::Entity

pub struct Entity<D, C = Value> {
    pub meta: EntityMeta,
    pub spec: D,
    pub children: Option<Vec<C>>,
}

An entity with associated data.

Fields

meta: EntityMeta

Common entity metadata.

spec: D

Specification of the entity.

children: Option<Vec<C>>

Inline child entity specs.

Implementations

impl<D> Entity<D>

pub fn new_with_name(name: impl Into<String>, spec: D) -> Self

pub fn try_map_spec<F, O, E>(self, f: F) -> Result<Entity<O>, E>

where F: FnOnce(D) -> Result<O, E>,

pub fn uid(&self) -> Option<Uuid>

impl<D, C> Entity<D, C>

where D: EntityDescriptorConst,

pub fn uri(&self) -> String

pub fn build_uri(&self) -> EntityUri

impl<D, C> Entity<D, C>

where D: EntityDescriptorConst + Serialize, C: Serialize,

pub fn to_json_map(&self) -> Result<Value, Error>

Convert this type to yaml, injecting the kind into the output.

pub fn to_json(&self) -> Result<String, Error>

pub fn to_yaml_map(&self) -> Result<Mapping, Error>

Convert this type to yaml, injecting the kind into the output.

pub fn to_yaml(&self) -> Result<String, Error>

Convert this type to yaml, injecting the kind into the output.

pub fn to_generic(&self) -> Result<GenericEntity, Error>

Converts this type into a generic entity

Trait Implementations

impl<D: Clone, C: Clone> Clone for Entity<D, C>

fn clone(&self) -> Entity<D, C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D: Debug, C: Debug> Debug for Entity<D, C>

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

Formats the value using the given formatter.

impl<'de, D, C> Deserialize<'de> for Entity<D, C>

where D: Deserialize<'de>, C: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<D: JsonSchema, C: JsonSchema> JsonSchema for Entity<D, C>

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<D: PartialEq, C: PartialEq> PartialEq for Entity<D, C>

fn eq(&self, other: &Entity<D, C>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<D, C> Serialize for Entity<D, C>

where D: Serialize, C: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<D: Eq, C: Eq> Eq for Entity<D, C>

impl<D, C> StructuralPartialEq for Entity<D, C>