Enum ClientToolName 

pub enum ClientToolName {
    AskMultipleChoiceQuestion,
    GeneratePasswordResetLink,
    ResetExercises,
    UpdateCheatingStatus,
    EditUserAccount,
    UpdateCertificate,
}

The name of a client tool, generated into the frontend as a string union so it names one of [ClientChatbotTool::NAME] by construction instead of by a hand-copied literal.

The bounds a tool enforces on its arguments and the shape of its answer stay hand-written on the frontend: routing those through the OpenAPI schema would need either a schema per tool or widening the argument and answer types this crate uses to serialize them, for a part of the contract that only fails loudly, unlike the name.

Variants

AskMultipleChoiceQuestion

GeneratePasswordResetLink

ResetExercises

UpdateCheatingStatus

EditUserAccount

UpdateCertificate

Implementations

impl ClientToolName

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

The wire name ChatbotToolDeclaration::NAME must equal for the tool this variant names.

Trait Implementations

impl Clone for ClientToolName

fn clone(&self) -> ClientToolName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for ClientToolName

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for ClientToolName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClientToolName

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ClientToolName

fn eq(&self, other: &ClientToolName) -> 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 ClientToolName

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for ClientToolName

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.

impl Copy for ClientToolName

impl Eq for ClientToolName

impl StructuralPartialEq for ClientToolName