Enum KnownIdPrefix 

pub enum KnownIdPrefix {
    ClientToolItem,
    Call,
    FunctionCallItem,
    FunctionCallOutputItem,
    CustomToolCallOutputItem,
    ToolSearchCallItem,
    ToolSearchOutputItem,
    AdditionalToolsItem,
    CompactionItem,
    ImageGenerationItem,
    LocalShellItem,
    WebSearchItem,
    CallToolCall,
    Reasoning,
    Message,
    Response,
    Tool,
}

Prefix conventions used when generating ids, not universal input validators. Sources: samples/codex/codex-rs/protocol/src/models.rs id_prefix(); upstream_docs OpenAI Responses examples and Claude tool_use examples. Existing legal ids are not rejected just for lacking these prefixes. Exact prefixes used by known wire ids. Matching is boundary-aware: call_foo is recognized while callback is not.

Variants

ClientToolItem

Gateway-generated item ID for a bound client action, not an upstream convention.

Call

FunctionCallItem

FunctionCallOutputItem

CustomToolCallOutputItem

ToolSearchCallItem

ToolSearchOutputItem

AdditionalToolsItem

CompactionItem

ImageGenerationItem

LocalShellItem

WebSearchItem

CallToolCall

Reasoning

Message

Response

Tool

Implementations

impl KnownIdPrefix

pub const fn as_str(self) -> &'static str

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

Trait Implementations

impl Clone for KnownIdPrefix

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KnownIdPrefix

impl Debug for KnownIdPrefix

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KnownIdPrefix

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for KnownIdPrefix

impl Hash for KnownIdPrefix

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

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 KnownIdPrefix

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for KnownIdPrefix

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KnownIdPrefix