Skip to main content

Crate unionid_query

Crate unionid_query 

Source
Expand description

Compile-time checked inline queries for Unionid Rust applications.

queries! binds one or more inline Unionid operations against an explicit declarative schema, then expands to the same typed Rust bindings produced by unionid query rust --dir.

Binding errors are reported while compiling the Rust crate. For example, this unknown field is rejected before the application can run:

ⓘ
unionid_query::queries! {
    schema "tests/schema.unid"
    query unknown_field {
        from tasks
        filter missing == 1
    }
}

Constructors are checked against the schema:

ⓘ
unionid_query::queries! {
    schema "tests/schema.unid"
    query invalid_constructor {
        from tasks
        filter match state {
            Missing => true
            _ => false
        }
    }
}

A parameter must have one inferred type throughout a query:

ⓘ
unionid_query::queries! {
    schema "tests/schema.unid"
    query parameter_conflict {
        from tasks
        filter id == $value && title == $value
    }
}

Matches must cover every constructor:

ⓘ
unionid_query::queries! {
    schema "tests/schema.unid"
    query non_exhaustive_match {
        from tasks
        filter match state {
            Pending => true
            Running {..} => false
        }
    }
}

Generated defaults may be omitted on insert, but an upsert key is required:

ⓘ
unionid_query::queries! {
    schema "tests/generated.unid"
    query replace_item {upsert items $item}
}
let _ = replace_item::ReplaceItemParams {
    item: replace_item::ReplaceItemParamsItem {
        id: None,
        owner: "missing key".into(),
        state: State::Pending,
        detail: Detail {note: None},
        public_id: None,
        created_at: None,
    },
};

Macros§

queries
Bind inline Unionid queries against a declarative schema and generate typed Rust models, parameters, result rows, and execution functions.