Struct SearchAttributeKey 

pub struct SearchAttributeKey<T>
where
    T: SearchAttributeValue,
{ /* private fields */ }

A typed handle for a named search attribute, carrying its value type at the type level. Construct via the const factory methods such as SearchAttributeKey::bool, SearchAttributeKey::keyword, etc.

Key names

Key names must be &'static str, which enables compile-time construction via const but means runtime-determined key names are not supported. For dynamic key names (e.g., from config), use SearchAttributes::raw_payload as an escape hatch for untyped access.

use temporalio_common_wasm::search_attributes::SearchAttributeKey;

const MY_KEY: SearchAttributeKey<String> = SearchAttributeKey::keyword("my_attr");

Implementations

impl<T> SearchAttributeKey<T>

where T: SearchAttributeValue,

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

Returns the attribute name used as the key in the proto map.

pub fn indexed_value_type(&self) -> IndexedValueType

Returns the IndexedValueType configured for this key.

pub fn value_set(&self, val: T) -> SearchAttributeUpdate

Create a SearchAttributeUpdate that sets the attribute to the given value.

Panics

Panics if the value cannot be serialized to JSON. This can happen for f64 values that are NaN or Infinity (which are not valid JSON), or for Timestamp values with out-of-range seconds. Use try_value_set for a fallible alternative.

pub fn try_value_set( &self, val: T, ) -> Result<SearchAttributeUpdate, SearchAttributeError>

Fallible version of value_set. Returns an error instead of panicking if the value cannot be serialized.

pub fn value_unset(&self) -> SearchAttributeUpdate

Create a SearchAttributeUpdate that removes this attribute.

impl SearchAttributeKey<bool>

pub const fn bool(name: &'static str) -> SearchAttributeKey<bool>

Create a key for a Bool-typed search attribute.

impl SearchAttributeKey<i64>

pub const fn int(name: &'static str) -> SearchAttributeKey<i64>

Create a key for an Int-typed search attribute.

impl SearchAttributeKey<f64>

pub const fn float(name: &'static str) -> SearchAttributeKey<f64>

Create a key for a Double-typed search attribute.

impl SearchAttributeKey<String>

pub const fn keyword(name: &'static str) -> SearchAttributeKey<String>

Create a key for a Keyword-typed search attribute.

pub const fn text(name: &'static str) -> SearchAttributeKey<String>

Create a key for a Text-typed search attribute.

impl SearchAttributeKey<Timestamp>

pub const fn datetime(name: &'static str) -> SearchAttributeKey<Timestamp>

Create a key for a Datetime-typed search attribute.

impl SearchAttributeKey<Vec<String>>

pub const fn keyword_list(name: &'static str) -> SearchAttributeKey<Vec<String>>

Create a key for a KeywordList-typed search attribute.

Trait Implementations

impl<T> Clone for SearchAttributeKey<T>

where T: Clone + SearchAttributeValue,

fn clone(&self) -> SearchAttributeKey<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Copy for SearchAttributeKey<T>

where T: Copy + SearchAttributeValue,

impl<T> Debug for SearchAttributeKey<T>

where T: Debug + SearchAttributeValue,

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

Formats the value using the given formatter.