stof 0.3.24

Stof is a unified data interface and interchange format for creating, sharing, and manipulating data. Stof removes the fragile and cumbersome parts of combining and using data in applications.
Documentation 
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

//
// Copyright 2024 Formata, Inc. All rights reserved.
//
// Licensed 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 crate::{lang::SError, Format, IntoNodeRef, SDoc, SField, SGraph};


/// Stof TEXT interface.
pub struct TEXT;
impl TEXT {
    /// Parse some text into a new document.
    pub fn parse_new(text: &str) -> SDoc {
        SDoc::new(Self::parse(text))
    }

    /// Parse some text into a new graph.
    pub fn parse(text: &str) -> SGraph {
        let mut graph = SGraph::default();
        let root = graph.insert_root("root");
        SField::new_string(&mut graph, "text", text, &root);
        graph
    }

    /// Stringify.
    pub fn stringify(pid: &str, doc: &SDoc) -> Result<String, SError> {
        if let Some(field) = SField::field(&doc.graph, "text", '.', doc.graph.main_root().as_ref()) {
            return Ok(field.to_string());
        }
        Err(SError::fmt(pid, &doc, "text", "did not find a 'text' field on the main root of this graph to stringify"))
    }

    /// Stringify node.
    pub fn stringify_node(pid: &str, doc: &SDoc, node: impl IntoNodeRef) -> Result<String, SError> {
        if let Some(field) = SField::field(&doc.graph, "text", '.', Some(&node.node_ref())) {
            return Ok(field.to_string());
        }
        Err(SError::fmt(pid, doc, "text", "did not find a 'text' field on this node to stringify"))
    }
}

impl Format for TEXT {
    /// Format getter.
    fn format(&self) -> String {
        "text".to_string()
    }

    /// Content type.
    fn content_type(&self) -> String {
        "text/plain".to_string()
    }

    /// Header import.
    fn header_import(&self, pid: &str, doc: &mut crate::SDoc, _content_type: &str, bytes: &mut bytes::Bytes, as_name: &str) -> Result<(), SError> {
        let res = std::str::from_utf8(bytes.as_ref());
        match res {
            Ok(str) => {
                self.string_import(pid, doc, str, as_name)
            },
            Err(error) => {
                Err(SError::fmt(pid, &doc, "text", &error.to_string()))
            }
        }
    }

    /// String import.
    fn string_import(&self, pid: &str, doc: &mut crate::SDoc, src: &str, as_name: &str) -> Result<(), SError> {
        let mut graph = TEXT::parse(src);
        if as_name.len() > 0 && as_name != "root" {
            let mut path = as_name.replace(".", "/");
            if as_name.starts_with("self") || as_name.starts_with("super") {
                if let Some(ptr) = doc.self_ptr(pid) {
                    path = format!("{}/{}", ptr.path(&doc.graph), path);
                }
            }

            // as_name is really a location, so ensure the nodes and move it there
            let mut loc_graph = SGraph::default();
            let loc = loc_graph.ensure_nodes(&path, '/', true, None);
            if let Some(main) = graph.main_root() {
                if let Some(main) = main.node(&graph) {
                    loc_graph.absorb_external_node(&graph, main, &loc);
                }
            }
            graph = loc_graph;
        }
        doc.graph.default_absorb_merge(graph)
    }

    /// File import.
    fn file_import(&self, pid: &str, doc: &mut crate::SDoc, _format: &str, full_path: &str, _extension: &str, as_name: &str) -> Result<(), SError> {
        let src = doc.fs_read_string(pid, full_path)?;
        self.string_import(pid, doc, &src, as_name)
    }

    /// Export string.
    fn export_string(&self, pid: &str, doc: &crate::SDoc, node: Option<&crate::SNodeRef>) -> Result<String, SError> {
        if node.is_some() {
            TEXT::stringify_node(pid, &doc, node)
        } else {
            TEXT::stringify(pid, &doc)
        }
    }
}