Make Type an opaque type

Author: sfackler

codegen/src/type_gen.rs

@@ -14,6 +14,7 @@ const PG_RANGE_H: &'static str = include_str!("pg_range.h");
 struct Type {
     name: &'static str,
     variant: String,
+    ident: String,
     kind: &'static str,
     element: u32,
     doc: String,
@@ -27,8 +28,8 @@ pub fn build(path: &Path) {
 
     make_header(&mut file);
     make_enum(&mut file, &types);
-    make_display_impl(&mut file);
     make_impl(&mut file, &types);
+    make_consts(&mut file, &types);
 }
 
 fn parse_ranges() -> BTreeMap<u32, u32> {
@@ -69,14 +70,10 @@ fn parse_types(ranges: &BTreeMap<u32, u32>) -> BTreeMap<u32, Type> {
 
         let name = split[5];
 
-        let variant = match name {
-            "anyarray" => "AnyArray".to_owned(),
-            name => {
-                let variant = range_vector_re.replace(name, "_$1");
-                let variant = array_re.replace(&variant, "$1_array");
-                snake_to_camel(&variant)
-            }
-        };
+        let ident = range_vector_re.replace(name, "_$1");
+        let ident = array_re.replace(&ident, "$1_array");
+        let variant = snake_to_camel(&ident);
+        let ident = ident.to_ascii_uppercase();
 
         let kind = split[11];
 
@@ -106,11 +103,12 @@ fn parse_types(ranges: &BTreeMap<u32, u32>) -> BTreeMap<u32, Type> {
         let doc = String::from_utf8(doc).unwrap();
 
         let type_ = Type {
-            name: name,
-            variant: variant,
-            kind: kind,
-            element: element,
-            doc: doc,
+            name,
+            variant,
+            ident,
+            kind,
+            element,
+            doc,
         };
 
         types.insert(oid, type_);
@@ -123,74 +121,60 @@ fn make_header(w: &mut BufWriter<File>) {
     write!(
         w,
         "// Autogenerated file - DO NOT EDIT
-use std::fmt;
+use std::sync::Arc;
 
-use types::{{Oid, Kind, Other}};
+use types::{{Type, Oid, Kind}};
 
+#[derive(PartialEq, Eq, Debug)]
+pub struct Other {{
+    pub name: String,
+    pub oid: Oid,
+    pub kind: Kind,
+    pub schema: String,
+}}
 "
     ).unwrap();
 }
 
 fn make_enum(w: &mut BufWriter<File>, types: &BTreeMap<u32, Type>) {
     write!(
         w,
-        "/// A Postgres type.
+        "
 #[derive(PartialEq, Eq, Clone, Debug)]
-pub enum Type {{
-"
+pub enum Inner {{"
     ).unwrap();
 
     for type_ in types.values() {
         write!(
             w,
-            "    /// {}
-    {},
-",
-            type_.doc,
+            "
+    {},",
             type_.variant
         ).unwrap();
     }
 
     write!(
         w,
-        r"    /// An unknown type.
-    Other(Other),
+        r"
+    Other(Arc<Other>),
 }}
 
 "
     ).unwrap();
 }
 
-fn make_display_impl(w: &mut BufWriter<File>) {
-    write!(w,
-r#"impl fmt::Display for Type {{
-    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {{
-        match self.schema() {{
-            "public" | "pg_catalog" => {{}}
-            schema => write!(fmt, "{{}}.", schema)?,
-        }}
-        fmt.write_str(self.name())
-    }}
-}}
-
-"#,
-       ).unwrap();
-}
-
 fn make_impl(w: &mut BufWriter<File>, types: &BTreeMap<u32, Type>) {
     write!(w,
-"impl Type {{
-    /// Returns the `Type` corresponding to the provided `Oid` if it
-    /// corresponds to a built-in type.
-    pub fn from_oid(oid: Oid) -> Option<Type> {{
+"impl Inner {{
+    pub fn from_oid(oid: Oid) -> Option<Inner> {{
         match oid {{
 ",
            ).unwrap();
 
     for (oid, type_) in types {
         write!(
             w,
-            "            {} => Some(Type::{}),
+            "            {} => Some(Inner::{}),
 ",
             oid,
             type_.variant
@@ -202,7 +186,6 @@ fn make_impl(w: &mut BufWriter<File>, types: &BTreeMap<u32, Type>) {
         }}
     }}
 
-    /// Returns the OID of the `Type`.
     pub fn oid(&self) -> Oid {{
         match *self {{
 ",
@@ -212,19 +195,18 @@ fn make_impl(w: &mut BufWriter<File>, types: &BTreeMap<u32, Type>) {
     for (oid, type_) in types {
         write!(
             w,
-            "            Type::{} => {},
+            "            Inner::{} => {},
 ",
             type_.variant,
             oid
         ).unwrap();
     }
 
     write!(w,
-"            Type::Other(ref u) => u.oid(),
+"            Inner::Other(ref u) => u.oid,
         }}
     }}
 
-    /// Returns the kind of this type.
     pub fn kind(&self) -> &Kind {{
         match *self {{
 ",
@@ -233,14 +215,14 @@ fn make_impl(w: &mut BufWriter<File>, types: &BTreeMap<u32, Type>) {
     for type_ in types.values() {
         let kind = match type_.kind {
             "P" => "Pseudo".to_owned(),
-            "A" => format!("Array(Type::{})", types[&type_.element].variant),
-            "R" => format!("Range(Type::{})", types[&type_.element].variant),
+            "A" => format!("Array(Type(Inner::{}))", types[&type_.element].variant),
+            "R" => format!("Range(Type(Inner::{}))", types[&type_.element].variant),
             _ => "Simple".to_owned(),
         };
 
         write!(
             w,
-            "            Type::{} => {{
+            "            Inner::{} => {{
                 const V: &'static Kind = &Kind::{};
                 V
             }}
@@ -251,19 +233,10 @@ fn make_impl(w: &mut BufWriter<File>, types: &BTreeMap<u32, Type>) {
     }
 
     write!(w,
-r#"            Type::Other(ref u) => u.kind(),
+r#"            Inner::Other(ref u) => &u.kind,
         }}
     }}
 
-    /// Returns the schema of this type.
-    pub fn schema(&self) -> &str {{
-        match *self {{
-            Type::Other(ref u) => u.schema(),
-            _ => "pg_catalog",
-        }}
-    }}
-
-    /// Returns the name of this type.
     pub fn name(&self) -> &str {{
         match *self {{
 "#,
@@ -272,7 +245,7 @@ r#"            Type::Other(ref u) => u.kind(),
     for type_ in types.values() {
         write!(
             w,
-            r#"            Type::{} => "{}",
+            r#"            Inner::{} => "{}",
 "#,
             type_.variant,
             type_.name
@@ -281,10 +254,34 @@ r#"            Type::Other(ref u) => u.kind(),
 
     write!(
         w,
-        "            Type::Other(ref u) => u.name(),
+        "            Inner::Other(ref u) => &u.name,
         }}
     }}
 }}
 "
     ).unwrap();
 }
+
+fn make_consts(w: &mut BufWriter<File>, types: &BTreeMap<u32, Type>) {
+    write!(w,
+"pub mod consts {{
+    use types::Type;
+    use types::type_gen::Inner;
+",
+           ).unwrap();
+
+    for type_ in types.values() {
+        write!(w,
+"
+    /// {docs}
+    pub const {ident}: Type = Type(Inner::{variant});
+",
+        docs = type_.doc,
+        ident = type_.ident,
+        variant = type_.variant).unwrap();
+    }
+
+    write!(w,
+"}}"
+    ).unwrap();
+}

postgres-shared/src/types/bit_vec.rs

@@ -4,7 +4,7 @@ use postgres_protocol::types;
 use self::bit_vec::BitVec;
 use std::error::Error;
 
-use types::{FromSql, ToSql, IsNull, Type};
+use types::{FromSql, ToSql, IsNull, Type, BIT, VARBIT};
 
 impl FromSql for BitVec {
     fn from_sql(_: &Type, raw: &[u8]) -> Result<BitVec, Box<Error + Sync + Send>> {
@@ -17,7 +17,7 @@ impl FromSql for BitVec {
         Ok(bitvec)
     }
 
-    accepts!(Type::Bit, Type::Varbit);
+    accepts!(BIT, VARBIT);
 }
 
 impl ToSql for BitVec {
@@ -26,6 +26,6 @@ impl ToSql for BitVec {
         Ok(IsNull::No)
     }
 
-    accepts!(Type::Bit, Type::Varbit);
+    accepts!(BIT, VARBIT);
     to_sql_checked!();
 }