Struct Modality 

pub struct Modality(/* private fields */);

A model’s primary output modality.

Implementations

impl Modality

pub fn unknown() -> Self

The well-known unknown value.

pub fn text() -> Self

The well-known text value.

pub fn image() -> Self

The well-known image value.

pub fn speech() -> Self

The well-known speech value.

pub fn audio() -> Self

The well-known audio value.

pub fn video() -> Self

The well-known video value.

pub fn vision() -> Self

The well-known vision value.

pub fn embedding() -> Self

The well-known embedding value.

pub fn as_str(&self) -> &str

The underlying string value.

Trait Implementations

impl AsRef<str> for Modality

fn as_ref(&self) -> &str

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

impl Clone for Modality

fn clone(&self) -> Modality

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Modality

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Modality

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Modality

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

Formats the value using the given formatter.

impl Eq for Modality

impl From<&str> for Modality

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<Modality> for String

fn from(value: Modality) -> Self

Converts to this type from the input type.

impl From<String> for Modality

fn from(value: String) -> Self

Converts to this type from the input type.

impl Hash for Modality

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 Ord for Modality

fn cmp(&self, other: &Modality) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Modality

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Modality

fn partial_cmp(&self, other: &Modality) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Modality

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 Modality