rustronomy_core/
lib.rs

1/*
2  Copyright© 2022 Raúl Wolters(1)
3
4  This file is part of rustronomy-core.
5
6  rustronomy is free software: you can redistribute it and/or modify it under
7  the terms of the European Union Public License version 1.2 or later, as
8  published by the European Commission.
9
10  rustronomy is distributed in the hope that it will be useful, but WITHOUT ANY
11  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12  A PARTICULAR PURPOSE. See the European Union Public License for more details.
13
14  You should have received a copy of the EUPL in an/all official language(s) of
15  the European Union along with rustronomy.  If not, see
16  <https://ec.europa.eu/info/european-union-public-licence_en/>.
17
18  (1) Resident of the Kingdom of the Netherlands; agreement between licensor and
19  licensee subject to Dutch law as per article 15 of the EUPL.
20*/
21
22#![doc(
23  html_logo_url = "https://raw.githubusercontent.com/smups/rustronomy/main/logos/Rustronomy_ferris.png?raw=true"
24)]
25//! This crate defines the shared API for all rustronomy-project crates.
26//! Its purpose is to provide the necessary traits and types to ensure
27//! interoperability within the rustronomy project.
28//!
29//! See the module docs down below for more details regarding specific API's.
30
31//Module Strucutre (module description is given in the module definition files)
32pub mod meta;
33pub mod universal_containers;
34
35/// Glob-importing this module brings into scope useful traits
36pub mod prelude {
37  pub use super::meta::{MetaContainer, MetaTag, MetaTagClone};
38}