Enum ValueType

Source

pub enum ValueType {
Show 28 variants    Null,
    Bool,
    Int,
    Uint,
    Double,
    String,
    Bytes,
    Struct(StructType),
    Duration,
    Timestamp,
    List(ListType),
    Map(MapType),
    Unknown,
    Type(TypeType),
    Error,
    Any,
    Dyn,
    Opaque(OpaqueType),
    Optional(OptionalType),
    BoolWrapper,
    IntWrapper,
    UintWrapper,
    DoubleWrapper,
    StringWrapper,
    BytesWrapper,
    TypeParam(TypeParamType),
    Function(FunctionType),
    Enum(EnumType),
}

Expand description

CEL type representation.

This enum represents all possible types in the CEL type system. CEL supports a rich type system including primitive types, complex types, and Protocol Buffer types. Each type corresponds to values that can be used in CEL expressions.

§Examples

§Basic Type Usage

use cel_cxx::*;

// Create different types
let int_type = ValueType::Int;
let string_type = ValueType::String;
let list_type = ValueType::List(ListType::new(ValueType::String));

// Check the kind of a type
assert_eq!(int_type.kind(), Kind::Int);

§Map Types

use cel_cxx::*;

let map_type = ValueType::Map(MapType::new(
    MapKeyType::String,
    ValueType::Int
));

assert_eq!(map_type.kind(), Kind::Map);

Variants§

§

Null

Null type - represents the absence of a value.

This corresponds to CEL’s null literal.

§

Bool

Boolean type - represents true/false values.

This corresponds to CEL’s bool type and literals like true and false.

§

Int

Signed 64-bit integer type.

This corresponds to CEL’s int type and integer literals like 42.

§

Uint

Unsigned 64-bit integer type.

This corresponds to CEL’s uint type and unsigned integer literals like 42u.

§

Double

Double-precision floating point type.

This corresponds to CEL’s double type and floating-point literals like 3.14.

§

String

String type.

This corresponds to CEL’s string type and string literals like "hello".

§

Bytes

Byte array type.

This corresponds to CEL’s bytes type and byte literals like b"hello".

§

Struct(StructType)

Struct type for Protocol Buffer messages.

This represents structured data types, typically Protocol Buffer messages.

§

Duration

Duration type from Protocol Buffers.

This corresponds to google.protobuf.Duration and duration literals like duration("1h").

§

Timestamp

Timestamp type from Protocol Buffers.

This corresponds to google.protobuf.Timestamp and timestamp literals like timestamp("2023-01-01T00:00:00Z").

§

List(ListType)

List type - represents ordered collections.

This corresponds to CEL’s list type and literals like [1, 2, 3].

§

Map(MapType)

Map type - represents key-value mappings.

This corresponds to CEL’s map type and literals like {"key": "value"}.

§

Unknown

Unknown type - used for values that cannot be determined at compile time.

This is typically used in error conditions or for dynamic values.

§

Type(TypeType)

Type type - represents type values themselves.

This corresponds to CEL’s type system where types can be values, such as int or string.

§

Error

Error type - represents error values.

This is used when evaluation results in an error condition.

§

Any

Any type from Protocol Buffers.

This corresponds to google.protobuf.Any which can hold any Protocol Buffer message.

§

Dyn

Dynamic type - represents values whose type is determined at runtime.

This is used for values that can be of any type.

§

Opaque(OpaqueType)

Opaque types - user-defined types that are not directly CEL types.

This allows integration of custom Rust types into CEL expressions.

§

Optional(OptionalType)

Optional type - represents values that may or may not be present.

This corresponds to CEL’s optional types and the optional type constructor.

§

BoolWrapper

Boolean wrapper type from Protocol Buffers.

This corresponds to google.protobuf.BoolValue.

§

IntWrapper

Integer wrapper type from Protocol Buffers.

This corresponds to google.protobuf.Int32Value.

§

UintWrapper

Unsigned integer wrapper type from Protocol Buffers.

This corresponds to google.protobuf.UInt32Value.

§

DoubleWrapper

Double wrapper type from Protocol Buffers.

This corresponds to google.protobuf.DoubleValue.

§

StringWrapper

String wrapper type from Protocol Buffers.

This corresponds to google.protobuf.StringValue.

§

BytesWrapper

Bytes wrapper type from Protocol Buffers.

This corresponds to google.protobuf.BytesValue.

§

TypeParam(TypeParamType)

Type parameter type - used in generic type definitions.

This represents type parameters in generic contexts.

§

Function(FunctionType)

Function type - represents function signatures.

This is used to represent the types of functions and their signatures.

§

Enum(EnumType)

Enum type - represents enumeration types.

This corresponds to Protocol Buffer enum types.

Implementations§

Source §

impl ValueType

Source

pub fn kind(&self) -> Kind

Returns the kind of this type.

The kind represents the basic category of the type, which is useful for type checking and dispatch logic.

§Examples

use cel_cxx::*;

assert_eq!(ValueType::Int.kind(), Kind::Int);
assert_eq!(ValueType::String.kind(), Kind::String);

let list_type = ValueType::List(ListType::new(ValueType::Int));
assert_eq!(list_type.kind(), Kind::List);

Source

pub fn is<T: TypedValue>(&self) -> bool

Checks if this type matches the type of a specific TypedValue implementation.

This method provides a type-safe way to check if a ValueType corresponds to a particular Rust type that implements TypedValue. It’s particularly useful for runtime type checking and validation.

§Type Parameters

T - A type that implements TypedValue, representing the Rust type to check against

§Returns

Returns true if this ValueType matches the CEL type representation of T, false otherwise.

§Examples

§Basic Type Checking

use cel_cxx::*;

// Check primitive types
assert!(ValueType::Int.is::<i64>());
assert!(ValueType::String.is::<String>());
assert!(ValueType::Bool.is::<bool>());

// Check against wrong types
assert!(!ValueType::Int.is::<String>());
assert!(!ValueType::String.is::<bool>());

§Collection Type Checking

use cel_cxx::*;
use std::collections::HashMap;

let list_type = ValueType::List(ListType::new(ValueType::Int));
let map_type = ValueType::Map(MapType::new(MapKeyType::String, ValueType::Int));

// Check collection types
assert!(list_type.is::<Vec<i64>>());
assert!(map_type.is::<HashMap<String, i64>>());

// Check against incompatible collection types
assert!(!list_type.is::<Vec<String>>());
assert!(!map_type.is::<HashMap<i64, String>>());

§Optional Type Checking

use cel_cxx::*;

let optional_string = ValueType::Optional(OptionalType::new(ValueType::String));

// Check optional types
assert!(optional_string.is::<Option<String>>());
assert!(!optional_string.is::<Option<i64>>());
assert!(!optional_string.is::<String>()); // Not optional

§Custom Opaque Type Checking

use cel_cxx::*;

#[derive(Opaque, Debug, Clone, PartialEq)]
#[cel_cxx(type = "my.CustomType")]
#[cel_cxx(display)]
struct CustomType {
    value: i32,
}

let opaque_type = <CustomType as TypedValue>::value_type();

// Check custom opaque type
assert!(opaque_type.is::<CustomType>());
assert!(!opaque_type.is::<i32>());

§Use Cases

This method is commonly used in:

Function implementations: Validating argument types before processing
Type guards: Ensuring type safety in generic contexts
Error handling: Providing detailed type mismatch error messages
Debugging: Runtime inspection of type compatibility

§See Also

TypedValue::value_type(): Get the ValueType representation of a Rust type
ValueType::kind(): Get the basic kind category of a type

Source

pub fn is_null(&self) -> bool

Checks if this type is a null type.

Source

pub fn is_bool(&self) -> bool

Checks if this type is a boolean type.

Source

pub fn is_int(&self) -> bool

Checks if this type is a signed integer type.

Source

pub fn is_uint(&self) -> bool

Checks if this type is an unsigned integer type.

Source

pub fn is_double(&self) -> bool

Checks if this type is a double type.

Source

pub fn is_string(&self) -> bool

Checks if this type is a string type.

Source

pub fn is_bytes(&self) -> bool

Checks if this type is a bytes type.

Source

pub fn is_struct(&self) -> bool

Checks if this type is a struct type.

Source

pub fn is_duration(&self) -> bool

Checks if this type is a duration type.

Source

pub fn is_timestamp(&self) -> bool

Checks if this type is a timestamp type.

Source

pub fn is_list(&self) -> bool

Checks if this type is a list type.

Source

pub fn is_map(&self) -> bool

Checks if this type is a map type.

Source

pub fn is_unknown(&self) -> bool

Checks if this type is a unknown type.

Source

pub fn is_type(&self) -> bool

Checks if this type is a type type.

Source

pub fn is_error(&self) -> bool

Checks if this type is a error type.

Source

pub fn is_any(&self) -> bool

Checks if this type is a any type.

Source

pub fn is_dyn(&self) -> bool

Checks if this type is a dyn type.

Source

pub fn is_opaque(&self) -> bool

Checks if this type is a opaque type.

Source

pub fn is_optional(&self) -> bool

Checks if this type is a optional type.

Source

pub fn is_bool_wrapper(&self) -> bool

Checks if this type is a bool wrapper type.

Source

pub fn is_int_wrapper(&self) -> bool

Checks if this type is a int wrapper type.

Source

pub fn is_uint_wrapper(&self) -> bool

Checks if this type is a uint wrapper type.

Source

pub fn is_double_wrapper(&self) -> bool

Checks if this type is a double wrapper type.

Source

pub fn is_string_wrapper(&self) -> bool

Checks if this type is a string wrapper type.

Source

pub fn is_bytes_wrapper(&self) -> bool

Checks if this type is a bytes wrapper type.

Source

pub fn is_type_param(&self) -> bool

Checks if this type is a type param type.

Source

pub fn is_function(&self) -> bool

Checks if this type is a function type.

Source

pub fn is_enum(&self) -> bool

Checks if this type is a enum type.

Trait Implementations§

Source §

impl Clone for ValueType

Source §

fn clone(&self) -> ValueType

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for ValueType

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Display for ValueType

Source §

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

Formats the value using the given formatter. Read more

Source §