Struct edge_schema::schema::EntityMeta

pub struct EntityMeta {
    pub uid: Option<Uuid>,
    pub name: String,
    pub description: Option<String>,
    pub labels: HashMap<String, String>,
    pub annotations: HashMap<String, Value>,
    pub parent: Option<EntityUri>,
}

Common entity metadata.

This data is not generic, and is the same for all entity kinds.

Fields

uid: Option<Uuid>

Optional unique id.

name: String

Name of the entity.

This is only unique within the scope of the entity.

description: Option<String>

Long description.

Should be either plain text or markdown.

labels: HashMap<String, String>

Labels are used to organize entities. They are a set of simple key/value pairs.

annotations: HashMap<String, Value>

Annotations are used to attach arbitrary metadata to entities. They can contain arbitrary (json-encodable) data.

parent: Option<EntityUri>

Implementations

impl EntityMeta

pub fn new(name: impl Into<String>) -> Self

pub fn with_uid(self, uid: Uuid) -> Self

pub fn with_annotations<I, K, V>(self, annotations: I) -> Self

where I: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<Value>,

Trait Implementations

impl Clone for EntityMeta

fn clone(&self) -> EntityMeta

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntityMeta

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EntityMeta

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for EntityMeta

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 PartialEq for EntityMeta

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for EntityMeta

impl StructuralPartialEq for EntityMeta