#[repr(i32)]
pub enum DataType { Unspecified = 0, Integer = 1, Float = 2, String = 3, Datetime = 5, GeoCoordinate = 7, ProtoAny = 8, Boolean = 9, List = 10, CustomizedStruct = 6, }
Expand description

Data type of the annotation.

Variants§

§

Unspecified = 0

Unspecified type.

§

Integer = 1

Integer type. Allowed search strategies:

  • DataSchema.SearchStrategy.NO_SEARCH,
  • DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by IntRangeArray.
§

Float = 2

Float type. Allowed search strategies:

  • DataSchema.SearchStrategy.NO_SEARCH,
  • DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by FloatRangeArray.
§

String = 3

String type. Allowed search strategies:

  • DataSchema.SearchStrategy.NO_SEARCH,
  • DataSchema.SearchStrategy.EXACT_SEARCH,
  • DataSchema.SearchStrategy.SMART_SEARCH.
§

Datetime = 5

Supported formats: %Y-%m-%dT%H:%M:%ES%Ez (absl::RFC3339_full) %Y-%m-%dT%H:%M:%ES %Y-%m-%dT%H:%M%Ez %Y-%m-%dT%H:%M %Y-%m-%dT%H%Ez %Y-%m-%dT%H %Y-%m-%d%Ez %Y-%m-%d %Y-%m %Y Allowed search strategies:

  • DataSchema.SearchStrategy.NO_SEARCH,
  • DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by DateTimeRangeArray.
§

GeoCoordinate = 7

Geo coordinate type. Allowed search strategies:

  • DataSchema.SearchStrategy.NO_SEARCH,
  • DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by GeoLocationArray.
§

ProtoAny = 8

Type to pass any proto as available in annotations.proto. Only use internally. Available proto types and its corresponding search behavior:

  • ImageObjectDetectionPredictionResult, allows SMART_SEARCH on display_names and NO_SEARCH.
  • ClassificationPredictionResult, allows SMART_SEARCH on display_names and NO_SEARCH.
  • ImageSegmentationPredictionResult, allows NO_SEARCH.
  • VideoActionRecognitionPredictionResult, allows SMART_SEARCH on display_name and NO_SEARCH.
  • VideoObjectTrackingPredictionResult, allows SMART_SEARCH on display_name and NO_SEARCH.
  • VideoClassificationPredictionResult, allows SMART_SEARCH on display_name and NO_SEARCH.
  • OccupancyCountingPredictionResult, allows EXACT_SEARCH on stats.full_frame_count.count and NO_SEARCH.
  • ObjectDetectionPredictionResult, allows SMART_SEARCH on identified_boxes.entity.label_string and NO_SEARCH.
§

Boolean = 9

Boolean type. Allowed search strategies:

  • DataSchema.SearchStrategy.NO_SEARCH,
  • DataSchema.SearchStrategy.EXACT_SEARCH.
§

List = 10

List type.

  • Each element in the list must be of the exact same data schema; otherwise, they are invalid arguments.
  • List level cannot set search strategy. Leaf node level can do.
  • Elements cannot be another list (no list of list).
  • Elements can be CUSTOMIZED_STRUCT, and max number of layers is 10.
§

CustomizedStruct = 6

Struct type.

  • SearchStrategy:
    • Data Schema that’s CUSTOMIZED_STRUCT cannot set search strategy.
    • Leaf-node elements allow setting search strategy based on element’s SearchStrategy restriction.
  • Nested layer restrictions:
    • Data Schema that’s CUSTOMIZED_STRUCT allows its fields to be of CUSTOMIZED_STRUCT as well, but the overall layers restriction is 10.

Implementations§

source§

impl DataType

source

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of DataType.

source

pub fn from_i32(value: i32) -> Option<DataType>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a DataType, or None if value is not a valid variant.

source§

impl DataType

source

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

source

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations§

source§

impl Clone for DataType

source§

fn clone(&self) -> DataType

Returns a copy 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 DataType

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for DataType

source§

fn default() -> DataType

Returns the “default value” for a type. Read more
source§

impl From<DataType> for i32

source§

fn from(value: DataType) -> i32

Converts to this type from the input type.
source§

impl Hash for DataType

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for DataType

source§

fn cmp(&self, other: &DataType) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for DataType

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for DataType

source§

fn partial_cmp(&self, other: &DataType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl TryFrom<i32> for DataType

§

type Error = DecodeError

The type returned in the event of a conversion error.
source§

fn try_from(value: i32) -> Result<DataType, DecodeError>

Performs the conversion.
source§

impl Copy for DataType

source§

impl Eq for DataType

source§

impl StructuralPartialEq for DataType

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more