Add analyze endpoint to rust driver (#794)

## Usage and product changes
Adds support for the analyze endpoint to rust driver.

## Implementation
Implement protocol serialization/deserialization and request/response handling.

Author: krishnangovindraj

Cargo.lock

@@ -25,7 +25,7 @@ def typedb_artifact():
         artifact_name = "typedb-all-{platform}-{version}.{ext}",
         tag_source = deployment["artifact"]["release"]["download"],
         commit_source = deployment["artifact"]["snapshot"]["download"],
-        tag = "3.5.4"
+        commit = "429639dfbfced5dcf79d773c455e58fb485ccfda"
     )
 
 #def typedb_cloud_artifact():

dependencies/typedb/artifacts.bzl

@@ -28,12 +28,12 @@ def typedb_protocol():
     git_repository(
         name = "typedb_protocol",
         remote = "https://github.com/typedb/typedb-protocol",
-        tag = "3.4.0",  # sync-marker: do not remove this comment, this is used for sync-dependencies by @typedb_protocol
+        commit = "9d446848f69867b5d921793e6a7c77f8e035b150",  # sync-marker: do not remove this comment, this is used for sync-dependencies by @typedb_protocol
     )
 
 def typedb_behaviour():
     git_repository(
         name = "typedb_behaviour",
-        remote = "https://github.com/typedb/typedb-behaviour",
-        commit = "095a58cb823dd8436600526ceb3ff2c0bdf377f9",  # sync-marker: do not remove this comment, this is used for sync-dependencies by @typedb_behaviour
+        remote = "https://github.com/krishnangovindraj/typedb-behaviour",
+        commit = "69f45dd45e175319c855f0991d0161fcaf90b5ac",  # sync-marker: do not remove this comment, this is used for sync-dependencies by @typedb_behaviour
     )

dependencies/typedb/repositories.bzl

@@ -0,0 +1,24 @@
+[#_struct_AnalyzedQuery]
+=== AnalyzedQuery
+
+*Implements traits:*
+
+* `Clone`
+* `Debug`
+
+An ``AnalyzedQuery`` contains the server’s representation of the query and preamble functions; as well as the result of types inferred for each variable by type-inference.
+
+[caption=""]
+.Fields
+// tag::properties[]
+[cols=",,"]
+[options="header"]
+|===
+|Name |Type |Description
+a| `fetch` a| `Option<Fetch>` a| 
+a| `preamble` a| `Vec<Function>` a| 
+a| `query` a| `Pipeline` a| 
+a| `source` a| `String` a| 
+|===
+// end::properties[]
+

docs/modules/ROOT/partials/rust/analyze/AnalyzedQuery.adoc

@@ -0,0 +1,23 @@
+[#_enum_Comparator]
+=== Comparator
+
+A representation of the comparator used in a comparison constraint.
+
+[caption=""]
+.Enum variants
+// tag::enum_constants[]
+[cols=""]
+[options="header"]
+|===
+|Variant
+a| `Contains = 7`
+a| `Equal = 0`
+a| `Greater = 4`
+a| `GreaterOrEqual = 5`
+a| `LessOrEqual = 3`
+a| `LessThan = 2`
+a| `Like = 6`
+a| `NotEqual = 1`
+|===
+// end::enum_constants[]
+

docs/modules/ROOT/partials/rust/analyze/Comparator.adoc

@@ -0,0 +1,22 @@
+[#_struct_Conjunction]
+=== Conjunction
+
+*Implements traits:*
+
+* `Clone`
+* `Debug`
+
+A representation of the constraints involved in the query, and types inferred for each variable.
+
+[caption=""]
+.Fields
+// tag::properties[]
+[cols=",,"]
+[options="header"]
+|===
+|Name |Type |Description
+a| `constraints` a| `Vec<ConstraintWithSpan>` a| 
+a| `variable_annotations` a| `HashMap<Variable, VariableAnnotations>` a| 
+|===
+// end::properties[]
+

docs/modules/ROOT/partials/rust/analyze/Conjunction.adoc

@@ -0,0 +1,22 @@
+[#_struct_ConjunctionID]
+=== ConjunctionID
+
+*Implements traits:*
+
+* `Clone`
+* `Copy`
+* `Debug`
+
+Holds the index of the conjunction in a ``Pipeline``’s ``conjunctions`` field. Used as indirection in the representation of a pipeline.
+
+[caption=""]
+.Fields
+// tag::properties[]
+[cols=",,"]
+[options="header"]
+|===
+|Name |Type |Description
+a| `0` a| `usize` a| 
+|===
+// end::properties[]
+

docs/modules/ROOT/partials/rust/analyze/ConjunctionID.adoc

@@ -0,0 +1,33 @@
+[#_enum_Constraint]
+=== Constraint
+
+The constraints making up a conjunction.
+
+[caption=""]
+.Enum variants
+// tag::enum_constants[]
+[cols=""]
+[options="header"]
+|===
+|Variant
+a| `Comparison`
+a| `Expression`
+a| `FunctionCall`
+a| `Has`
+a| `Iid`
+a| `Is`
+a| `Isa`
+a| `Kind`
+a| `Label`
+a| `Links`
+a| `Not`
+a| `Or`
+a| `Owns`
+a| `Plays`
+a| `Relates`
+a| `Sub`
+a| `Try`
+a| `Value`
+|===
+// end::enum_constants[]
+

docs/modules/ROOT/partials/rust/analyze/Constraint.adoc

@@ -0,0 +1,17 @@
+[#_enum_ConstraintExactness]
+=== ConstraintExactness
+
+Tells apart exact variants of constraints from the ones allowing subtype-polymorphism. e.g. <code>isa!</code> would be represented as an <code>Constraint::Isa</code> with its exactness field <code>ConstraintExactness::Exact</code>.
+
+[caption=""]
+.Enum variants
+// tag::enum_constants[]
+[cols=""]
+[options="header"]
+|===
+|Variant
+a| `Exact = 0`
+a| `Subtypes = 1`
+|===
+// end::enum_constants[]
+

docs/modules/ROOT/partials/rust/analyze/ConstraintExactness.adoc

@@ -0,0 +1,8 @@
+[#_struct_ConstraintSpan]
+=== ConstraintSpan
+
+*Implements traits:*
+
+* `Clone`
+* `Debug`
+