Enum GenerateError 

pub enum GenerateError {
    UnsupportedSurfaceApi {
        found: u32,
        expected: u32,
    },
    NoTablesModule {
        modules: Vec<String>,
    },
    UnknownAction {
        action: String,
    },
    UnreadableAction {
        action: String,
        why: String,
    },
    UnsupportedTableName {
        table: String,
    },
}

Why generation refused. Every case is a contract this generator cannot honour, and every Display says what to do about it.

Variants

UnsupportedSurfaceApi

The document’s surface_api is not the contract this generator speaks: a newer (or corrupted) server than the generator.

Fields

found: u32

What the document declared.

expected: u32

What this generator reads.

NoTablesModule

The document declares no tables module, so there is no contract to generate a client from.

Fields

modules: Vec<String>

The modules the document does declare.

UnknownAction

An action in the Tables module whose name is not one of the five verbs the module publishes (list-/read-/create-/ replace-/delete-, then the table name).

Fields

action: String

The action’s name.

UnreadableAction

An action whose name parses but whose method or path is not what its verb promises — a contract drifted from its own vocabulary.

Fields

action: String

The action’s name.

why: String

What is wrong with it.

UnsupportedTableName

A table whose name is not a safe identifier: lowercase snake-case ([a-z][a-z0-9_]*, no double or trailing underscore), the same rule cratefield_tables::is_identifier enforces on a declaration. The /__surface document is untrusted input — the documented usage is curl -s https://venture/__surface | fz client-ts — and the name is interpolated into the generated TypeScript, so anything it cannot spell is refused rather than renamed: a silently renamed table would produce a client that calls the wrong route.

Fields

table: String

The offending table’s name, as the document spelled it.

Trait Implementations

impl Clone for GenerateError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateError

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

Formats the value using the given formatter.

impl Display for GenerateError

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

Formats the value using the given formatter.

impl Eq for GenerateError

impl Error for GenerateError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for GenerateError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for GenerateError