Enum Role 

#[non_exhaustive]
pub enum Role {
    System,
    Developer,
    User,
    Assistant,
    Function,
    Tool,
    Other(String),
}

The role of a message author.

Forward compatibility

OpenAI adds roles over time - developer was introduced as the reasoning-model replacement for system. Unrecognised roles deserialize into Other instead of failing the whole response, and the enum is #[non_exhaustive] so future additions are not breaking changes.

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 instructions

Developer

Developer instructions - the reasoning-model replacement for system

User

End-user input

Assistant

Model output

Function

Legacy function result

Tool

Tool call result

Other(String)

A role this version of the library does not know about

Implementations

impl Role

pub fn as_str(&self) -> &str

Returns the wire representation of this role.

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Role

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

Formats the value using the given formatter.

impl Eq for Role

impl Hash for Role

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 Role

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Role

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 Role

impl TryFrom<String> for Role

fn try_from(role: String) -> Result<Self, Self::Error>

Parses a caller-supplied role.

This stays strict and rejects unknown values, unlike deserialization, which has to tolerate whatever the API sends. Construct Role::Other directly if you need to pass through an unrecognised role.

type Error = &'static str

The type returned in the event of a conversion error.