Enum Role 

#[non_exhaustive]
pub enum Role {
    System,
    User,
    Assistant,
    Tool,
    Other,
}

Role of a participant in a chat conversation.

Serialises to lowercase strings as required by the OpenAI wire protocol (e.g. Role::User → "user").

Unknown roles from the wire (e.g. provider-specific extensions) deserialise to Role::Other instead of causing a hard failure, ensuring forward compatibility as providers evolve their APIs.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

System

System-level instructions provided before the conversation begins.

User

Message from the human user.

Assistant

Response generated by the AI assistant.

Tool

Result message from a tool/function call execution.

Other

Catch-all for unknown or future role values from the wire.

Serialises to "other". The original wire string is not preserved; use this variant only for forward-compatible deserialisation, not for constructing outbound messages with non-standard roles.

Trait Implementations

impl Clone for Role

fn clone(&self) -> Role

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Role

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Role

fn deserialize<__D>( __deserializer: __D, ) -> Result<Role, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Role

impl PartialEq for Role

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Role

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.

impl StructuralPartialEq for Role