Enum PublicKind 

pub enum PublicKind {
    Any,
    None,
    Null,
    Bool,
    Bytes,
    Datetime,
    Decimal,
    Duration,
    Float,
    Int,
    Number,
    Object,
    String,
    Uuid,
    Regex,
    Table(Vec<Table>),
    Record(Vec<Table>),
    Geometry(Vec<GeometryKind>),
    Either(Vec<Kind>),
    Set(Box<Kind>, Option<u64>),
    Array(Box<Kind>, Option<u64>),
    Function(Option<Vec<Kind>>, Option<Box<Kind>>),
    Range,
    Literal(KindLiteral),
    File(Vec<String>),
}

The kind of a SurrealDB value.

Variants

Any

The most generic type, can be anything.

None

None type.

Null

Null type.

Bool

Boolean type.

Bytes

Bytes type.

Datetime

Datetime type.

Decimal

Decimal type.

Duration

Duration type.

Float

64-bit floating point type.

Int

64-bit signed integer type.

Number

Number type, can be either a float, int or decimal. This is the most generic type for numbers.

Object

Object type.

String

String type.

Uuid

UUID type.

Regex

Regular expression type.

Table(Vec<Table>)

A table type.

Record(Vec<Table>)

A record type.

Geometry(Vec<GeometryKind>)

A geometry type.

Either(Vec<Kind>)

An either type. Can be any of the kinds in the vec.

Set(Box<Kind>, Option<u64>)

A set type.

Array(Box<Kind>, Option<u64>)

An array type.

Function(Option<Vec<Kind>>, Option<Box<Kind>>)

A function type. The first option is the argument types, the second is the optional return type.

Range

A range type.

Literal(KindLiteral)

A literal type. The literal type is used to represent a type that can only be a single value. For example, "a" is a literal type which can only ever be "a". This can be used in the Kind::Either type to represent an enum.

File(Vec<String>)

A file type. If the kind was specified without a bucket the vec will be empty. So <file> is just Kind::File(Vec::new())

Implementations

impl Kind

pub fn flatten(self) -> Vec<Kind>

Recursively flatten a kind into a vector of kinds.

pub fn either(kinds: Vec<Kind>) -> Kind

Create an either kind from a vector of kinds. If after dedeplication the vector is empty, return Kind::None. If after dedeplication the vector has one element, return that element. If after dedeplication the vector has multiple elements, return an Either kind with the elements.

pub fn option(kind: Kind) -> Kind

Create an option kind from a kind.

Trait Implementations

impl Clone for Kind

fn clone(&self) -> Kind

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Kind

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Kind

fn default() -> Kind

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Kind

fn deserialize<__D>( __deserializer: __D, ) -> Result<Kind, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Kind

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<Kind> for PublicKind

fn from(v: Kind) -> Self

Converts to this type from the input type.

impl From<Kind> for Kind

fn from(v: PublicKind) -> Self

Converts to this type from the input type.

impl FromFlatbuffers for Kind

type Input<'a> = Kind<'a>

The input type from the flatbuffers builder

fn from_fb(input: <Kind as FromFlatbuffers>::Input<'_>) -> Result<Kind, Error>

Convert a flatbuffers builder type to a type.

impl Hash for Kind

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Kind

fn eq(&self, other: &Kind) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Kind

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToFlatbuffers for Kind

type Output<'bldr> = WIPOffset<Kind<'bldr>>

The output type for the flatbuffers builder

fn to_fb<'bldr>( &self, builder: &mut FlatBufferBuilder<'bldr>, ) -> Result<<Kind as ToFlatbuffers>::Output<'bldr>, Error>

Convert the type to a flatbuffers builder type.

impl ToSql for Kind

fn fmt_sql(&self, f: &mut String, fmt: SqlFormat)

Format the type to a SQL string.

fn to_sql(&self) -> String

Convert the type to a SQL string.

fn to_sql_pretty(&self) -> String

Convert the type to a pretty-printed SQL string with indentation.

impl Eq for Kind

impl StructuralPartialEq for Kind