typedb_driver/answer/
mod.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

use std::{fmt, sync::Arc};

use futures::StreamExt;

pub use self::{concept_document::ConceptDocument, concept_row::ConceptRow, json::JSON};
use crate::{
    answer::{concept_document::ConceptDocumentHeader, concept_row::ConceptRowHeader},
    BoxStream, Result,
};

pub mod concept_document;
pub mod concept_row;
mod json;

pub enum QueryAnswer {
    Ok(QueryType),
    ConceptRowStream(Arc<ConceptRowHeader>, BoxStream<'static, Result<ConceptRow>>),
    ConceptDocumentStream(Arc<ConceptDocumentHeader>, BoxStream<'static, Result<ConceptDocument>>),
}

impl QueryAnswer {
    /// Retrieve the executed query's type (shared by all elements in this stream).
    ///
    /// # Examples
    ///
    /// ```rust
    /// query_answer.get_query_type()
    /// ```
    pub fn get_query_type(&self) -> QueryType {
        match &self {
            QueryAnswer::Ok(query_type) => query_type.clone(),
            QueryAnswer::ConceptRowStream(header, _) => header.query_type,
            QueryAnswer::ConceptDocumentStream(header, _) => header.query_type,
        }
    }

    /// Check if the <code>QueryAnswer</code> is an <code>Ok</code> response.
    ///
    /// # Examples
    ///
    /// ```rust
    /// query_answer.is_ok()
    /// ```
    pub fn is_ok(&self) -> bool {
        matches!(self, Self::Ok(_))
    }

    /// Check if the <code>QueryAnswer</code> is a <code>ConceptRowStream</code>.
    ///
    /// # Examples
    ///
    /// ```rust
    /// query_answer.is_row_stream()
    /// ```
    pub fn is_row_stream(&self) -> bool {
        matches!(self, Self::ConceptRowStream(_, _))
    }

    /// Check if the <code>QueryAnswer</code> is a <code>ConceptDocumentStream</code>.
    ///
    /// # Examples
    ///
    /// ```rust
    /// query_answer.is_document_stream()
    /// ```
    pub fn is_document_stream(&self) -> bool {
        matches!(self, Self::ConceptDocumentStream(_, _))
    }

    /// Unwraps the <code>QueryAnswer</code> into a <code>ConceptRowStream</code>.
    /// Panics if it is not a <code>ConceptRowStream</code>.
    ///
    /// # Examples
    ///
    /// ```rust
    /// query_answer.into_rows()
    /// ```
    pub fn into_rows(self) -> BoxStream<'static, Result<ConceptRow>> {
        if let Self::ConceptRowStream(_, stream) = self {
            stream
        } else {
            panic!("Query answer is not a rows stream.")
        }
    }

    /// Unwraps the <code>QueryAnswer</code> into a <code>ConceptDocumentStream</code>.
    /// Panics if it is not a <code>ConceptDocumentStream</code>.
    ///
    /// # Examples
    ///
    /// ```rust
    /// query_answer.into_documents()
    /// ```
    pub fn into_documents(self) -> BoxStream<'static, Result<ConceptDocument>> {
        if let Self::ConceptDocumentStream(_, stream) = self {
            stream
        } else {
            panic!("Query answer is not a documents stream.")
        }
    }
}

impl fmt::Debug for QueryAnswer {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            QueryAnswer::Ok(_) => write!(f, "QueryAnswer::Ok"),
            QueryAnswer::ConceptRowStream(_, _) => write!(f, "QueryAnswer::ConceptRowStream(<stream>)"),
            QueryAnswer::ConceptDocumentStream(_, _) => write!(f, "QueryAnswer::ConceptDocumentStream(<stream>)"),
        }
    }
}

/// This enum is used to specify the type of the query resulted in this answer.
///
/// # Examples
///
/// ```rust
/// concept_row.get_query_type()
/// ```
#[repr(C)]
#[derive(Clone, Copy, Hash, PartialEq, Eq, Debug)]
pub enum QueryType {
    ReadQuery,
    WriteQuery,
    SchemaQuery,
}