typedb_driver/concept/
mod.rs

1/*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements.  See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership.  The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License.  You may obtain a copy of the License at
9 *
10 *   http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied.  See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20mod thing;
21mod type_;
22mod value;
23
24pub use self::{
25    thing::{Attribute, Entity, Relation, Thing},
26    type_::{Annotation, AttributeType, EntityType, RelationType, RoleType, RootThingType, ScopedLabel, ThingType},
27    value::{Value, ValueType},
28};
29
30/// The fundamental TypeQL object. A Concept is either a Type, Thing, or Value.
31/// To use subtype specific methods, the Concept must be of the expected subtype.
32#[derive(Clone, Debug, PartialEq)]
33pub enum Concept {
34    RootThingType(RootThingType),
35
36    EntityType(EntityType),
37    RelationType(RelationType),
38    RoleType(RoleType),
39    AttributeType(AttributeType),
40
41    Entity(Entity),
42    Relation(Relation),
43    Attribute(Attribute),
44
45    Value(Value),
46}
47
48/// Used for specifying whether we need explicit or transitive subtyping, instances, etc.
49///
50/// # Examples
51///
52/// ```rust
53/// entity_type.get_subtypes(transaction, Transitivity::Transitive);
54/// relation_type.get_instances(transaction, Transitivity::Explicit);
55/// ```
56#[repr(C)]
57#[derive(Copy, Clone, Debug, Eq, PartialEq)]
58pub enum Transitivity {
59    Explicit,
60    Transitive,
61}
62
63/// Represents invalid schema constructs discovered during schema validation.
64#[derive(Clone, Debug)]
65pub struct SchemaException {
66    pub code: String,
67    pub message: String,
68}
typedb_driver/concept/mod.rs

typedb_driver/concept/
mod.rs
