Skip to main content

IdempotencyKey

Struct IdempotencyKey 

Source
pub struct IdempotencyKey(/* private fields */);
Available on crate feature unstable_protocol_v2 only.
Expand description

A key the Client generates to identify one session/prompt submission across attempts.

The key is an opaque, case-sensitive string of 1 to 255 characters. It is scoped to the session named by the request’s sessionId.

See protocol docs: Retrying a prompt

Implementations§

Source§

impl IdempotencyKey

Source

pub const MAX_LENGTH: usize = 255

The maximum length of a key, in characters.

Source

pub fn new( key: impl Into<Arc<str>>, ) -> Result<IdempotencyKey, InvalidIdempotencyKey>

Wraps a string as a typed IdempotencyKey.

§Errors

Returns InvalidIdempotencyKey if the key is empty or longer than Self::MAX_LENGTH characters.

Source

pub fn generate() -> IdempotencyKey

Available on crate feature uuid only.

Generates a key from a random version 4 UUID (RFC 9562).

Generate one key per submission, when the user submits the input, and store it with the pending input. Every attempt for that submission sends the same key.

Source

pub fn as_str(&self) -> &str

Returns the key as a string slice.

Trait Implementations§

Source§

impl AsRef<str> for IdempotencyKey

Source§

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for IdempotencyKey

Source§

fn clone(&self) -> IdempotencyKey

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IdempotencyKey

Source§

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

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

impl<'de> Deserialize<'de> for IdempotencyKey

Source§

fn deserialize<D>( deserializer: D, ) -> Result<IdempotencyKey, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for IdempotencyKey

Source§

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

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

impl Eq for IdempotencyKey

Source§

impl From<Uuid> for IdempotencyKey

Available on crate feature uuid only.
Source§

fn from(uuid: Uuid) -> IdempotencyKey

Uses the UUID’s hyphenated lowercase form. It is 36 characters, so it is always a valid key.

Source§

impl FromStr for IdempotencyKey

Source§

type Err = InvalidIdempotencyKey

The associated error which can be returned from parsing.
Source§

fn from_str( key: &str, ) -> Result<IdempotencyKey, <IdempotencyKey as FromStr>::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for IdempotencyKey

Source§

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

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 JsonSchema for IdempotencyKey

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for IdempotencyKey

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for IdempotencyKey

Source§

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. Read more
Source§

impl StructuralPartialEq for IdempotencyKey

Source§

impl TryFrom<&str> for IdempotencyKey

Source§

type Error = InvalidIdempotencyKey

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

fn try_from( key: &str, ) -> Result<IdempotencyKey, <IdempotencyKey as TryFrom<&str>>::Error>

Performs the conversion.
Source§

impl TryFrom<String> for IdempotencyKey

Source§

type Error = InvalidIdempotencyKey

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

fn try_from( key: String, ) -> Result<IdempotencyKey, <IdempotencyKey as TryFrom<String>>::Error>

Performs the conversion.

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
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

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

Source§

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

Checks if this value is equivalent to the given key. Read more
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.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> IntoMaybeUndefined<T> for T

Source§

fn into_maybe_undefined(self) -> MaybeUndefined<T>

Converts this value into a three-state builder argument.
Source§

impl<T> IntoOption<T> for T

Source§

fn into_option(self) -> Option<T>

Converts this value into an optional builder argument.
Source§

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

Source§

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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