Enum StopField 

pub enum StopField {
    Single(String),
    Multiple(Vec<String>),
}

Stop field that accepts either a single string or an array of strings

Per OpenAI spec, the stop parameter can be a string or an array of up to 4 strings.

Variants

Single(String)

Single stop sequence

Multiple(Vec<String>)

Multiple stop sequences

Implementations

impl StopField

pub const fn len(&self) -> usize

Number of stop sequences in this field

pub const fn is_empty(&self) -> bool

Returns true if no stop sequences are present

pub fn into_vec(self) -> Vec<String>

Convert to a Vec of strings regardless of the variant, truncating to the OpenAI-specified maximum of 4 sequences

pub fn to_bounded_vec(&self) -> Vec<String>

Clone only the bounded subset (up to 4 sequences) without copying the entire input — safe for use with user-controlled data

Trait Implementations

impl Clone for StopField

fn clone(&self) -> StopField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StopField

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StopField

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.