c5180656cc
Steps to building docs locally: 1. Install Jekyll 2. cd docs 3. bundle exec jekyll serve --incremental 4. open local docs site at http://127.0.0.1:4000/ * basic Jekyll site * Add docs to documentation site * Update javadoc to allow for error free builds * Remove docs for rust dependencies * Better display examples, about and contributing documentation for Mentat * Version docs
1 line
No EOL
34 KiB
JSON
1 line
No EOL
34 KiB
JSON
{"Typealiases.html#/s:6Mentat5Entida":{"name":"Entid","abstract":"<p>Undocumented</p>"},"Structs.html#/s:6Mentat0A5ErrorV":{"name":"MentatError","abstract":"<p>Undocumented</p>"},"Protocols/Observable.html#/s:6Mentat10ObservableP8registerySS3key_AA9Observing_p8observerSaySSG10attributestF":{"name":"register(key:observer:attributes:)","abstract":"<p>Undocumented</p>","parent_name":"Observable"},"Protocols/Observable.html#/s:6Mentat10ObservableP10unregisterySS3key_tF":{"name":"unregister(key:)","abstract":"<p>Undocumented</p>","parent_name":"Observable"},"Protocols/Observing.html#/s:6Mentat9ObservingP19transactionDidOccurySS3key_SaySC8TxChangeVG7reportstF":{"name":"transactionDidOccur(key:reports:)","abstract":"<p>Undocumented</p>","parent_name":"Observing"},"Protocols/Observing.html":{"name":"Observing","abstract":"<p>Protocol to be implemented by any object that wishes to register for transaction observation</p>"},"Protocols/Observable.html":{"name":"Observable","abstract":"<p>Protocol to be implemented by any object that provides an interface to Mentat’s transaction observers.</p>"},"Extensions/Result.html#/s:SC6ResultV6MentatE6unwrapSvyKF":{"name":"unwrap()","abstract":"<p>Force unwraps a result.","parent_name":"Result"},"Extensions/Result.html#/s:SC6ResultV6MentatE9tryUnwrapSvSgyKF":{"name":"tryUnwrap()","abstract":"<p>Unwraps an optional result, yielding either a successful value or a nil.</p>","parent_name":"Result"},"Extensions/Date.html#/s:10Foundation4DateV6MentatE14toMicrosecondss5Int64VyF":{"name":"toMicroseconds()","abstract":"<p>This <code>Date</code> as microseconds.</p>","parent_name":"Date"},"Extensions/Date.html":{"name":"Date"},"Extensions/Result.html":{"name":"Result","abstract":"<p>Undocumented</p>"},"Enums/CacheDirection.html#/s:6Mentat14CacheDirectionO7forwardA2CmF":{"name":"forward","abstract":"<p>Undocumented</p>","parent_name":"CacheDirection"},"Enums/CacheDirection.html#/s:6Mentat14CacheDirectionO7reverseA2CmF":{"name":"reverse","abstract":"<p>Undocumented</p>","parent_name":"CacheDirection"},"Enums/CacheDirection.html#/s:6Mentat14CacheDirectionO4bothA2CmF":{"name":"both","abstract":"<p>Undocumented</p>","parent_name":"CacheDirection"},"Enums/ResultError.html#/s:6Mentat11ResultErrorO5errorACSS7message_tcACmF":{"name":"error","abstract":"<p>Undocumented</p>","parent_name":"ResultError"},"Enums/ResultError.html#/s:6Mentat11ResultErrorO5emptyA2CmF":{"name":"empty","abstract":"<p>Undocumented</p>","parent_name":"ResultError"},"Enums/PointerError.html#/s:6Mentat12PointerErrorO15pointerConsumedA2CmF":{"name":"pointerConsumed","abstract":"<p>Undocumented</p>","parent_name":"PointerError"},"Enums/QueryError.html#/s:6Mentat10QueryErrorO14invalidKeywordACSS7message_tcACmF":{"name":"invalidKeyword","abstract":"<p>Undocumented</p>","parent_name":"QueryError"},"Enums/QueryError.html#/s:6Mentat10QueryErrorO15executionFailedACSS7message_tcACmF":{"name":"executionFailed","abstract":"<p>Undocumented</p>","parent_name":"QueryError"},"Enums/QueryError.html":{"name":"QueryError","abstract":"<p>Undocumented</p>"},"Enums/PointerError.html":{"name":"PointerError","abstract":"<p>Undocumented</p>"},"Enums/ResultError.html":{"name":"ResultError","abstract":"<p>Undocumented</p>"},"Enums/CacheDirection.html":{"name":"CacheDirection","abstract":"<p>Undocumented</p>"},"Classes/TxReport.html#/s:6Mentat8TxReportC4txIds5Int64Vvp":{"name":"txId","abstract":"<p>Undocumented</p>","parent_name":"TxReport"},"Classes/TxReport.html#/s:6Mentat8TxReportC9txInstant10Foundation4DateVvp":{"name":"txInstant","abstract":"<p>Undocumented</p>","parent_name":"TxReport"},"Classes/TxReport.html#/s:6Mentat8TxReportC5entids5Int64VSgSS9forTempId_tF":{"name":"entid(forTempId:)","abstract":"<p>Access an <code><a href=\"36f8f5912051ae747ef441d6511ca4cbTypealiases.html#/s:6Mentat5Entida\">Entid</a></code> for a temporary identifier that was provided in the transaction.</p>","parent_name":"TxReport"},"Classes/TxReport.html#/s:6Mentat8TxReportC7cleanupys13OpaquePointerV7pointer_tF":{"name":"cleanup(pointer:)","abstract":"<p>Undocumented</p>","parent_name":"TxReport"},"Classes/InProgressBuilder.html#/s:6Mentat17InProgressBuilderC3addys5Int64V5entid_SS7keywordAF4longtKF":{"name":"add(entid:keyword:long:)","abstract":"<p>Asserts the value of attribute <code>keyword</code> to be the provided <code>value</code> for entity <code>entid</code>.</p>","parent_name":"InProgressBuilder"},"Classes/InProgressBuilder.html#/s:6Mentat17InProgressBuilderC3addys5Int64V5entid_SS7keywordAF9referencetKF":{"name":"add(entid:keyword:reference:)","abstract":"<p>Asserts the value of attribute <code>keyword</code> to be the provided <code>value</code> for entity <code>entid</code>.</p>","parent_name":"InProgressBuilder"},"Classes/InProgressBuilder.html#/s:6Mentat17InProgressBuilderC3addys5Int64V5entid_SS7keywordSSAHtKF":{"name":"add(entid:keyword:keyword:)","abstract":"<p>Asserts the value of attribute <code>keyword</code> to be the provided <code>value</code> for entity <code>entid</code>.</p>","parent_name":"InProgressBuilder"},"Classes/InProgressBuilder.html#/s:6Mentat17InProgressBuilderC3addys5Int64V5entid_SS7keywordSb7booleantKF":{"name":"add(entid:keyword:boolean:)","abstract":"<p>Asserts the value of attribute <code>keyword</code> to be the provided <code>value</code> for entity <code>entid</code>.</p>","parent_name":"InProgressBuilder"},"Classes/InProgressBuilder.html#/s:6Mentat17InProgressBuilderC3addys5Int64V5entid_SS7keywordSd6doubletKF":{"name":"add(entid:keyword:double:)","abstract":"<p>Asserts the value of attribute <code>keyword</code> to be the provided <code>value</code> for entity <code>entid</code>.</p>","parent_name":"InProgressBuilder"},"Classes/InProgressBuilder.html#/s:6Mentat17InProgressBuilderC3addys5Int64V5entid_SS7keyword10Foundation4DateV4datetKF":{"name":"add(entid:keyword:date:)","abstract":"<p>Asserts the value of attribute <code>keyword</code> to be the provided <code>value</code> for entity <code>entid</code>.</p>","parent_name":"InProgressBuilder"},"Classes/InProgressBuilder.html#/s:6Mentat17InProgressBuilderC3addys5Int64V5entid_SS7keywordSS6stringtKF":{"name":"add(entid:keyword:string:)","abstract":"<p>Asserts the value of attribute <code>keyword</code> to be the provided <code>value</code> for entity <code>entid</code>.</p>","parent_name":"InProgressBuilder"},"Classes/InProgressBuilder.html#/s:6Mentat17InProgressBuilderC3addys5Int64V5entid_SS7keyword10Foundation4UUIDV4uuidtKF":{"name":"add(entid:keyword:uuid:)","abstract":"<p>Asserts the value of attribute <code>keyword</code> to be the provided <code>value</code> for entity <code>entid</code>.</p>","parent_name":"InProgressBuilder"},"Classes/InProgressBuilder.html#/s:6Mentat17InProgressBuilderC7retractys5Int64V5entid_SS7keywordAF4longtKF":{"name":"retract(entid:keyword:long:)","abstract":"<p>Retracts the value of attribute <code>keyword</code> from the provided <code>value</code> for entity <code>entid</code>.</p>","parent_name":"InProgressBuilder"},"Classes/InProgressBuilder.html#/s:6Mentat17InProgressBuilderC7retractys5Int64V5entid_SS7keywordAF9referencetKF":{"name":"retract(entid:keyword:reference:)","abstract":"<p>Retracts the value of attribute <code>keyword</code> from the provided <code>value</code> for entity <code>entid</code>.</p>","parent_name":"InProgressBuilder"},"Classes/InProgressBuilder.html#/s:6Mentat17InProgressBuilderC7retractys5Int64V5entid_SS7keywordSSAHtKF":{"name":"retract(entid:keyword:keyword:)","abstract":"<p>Retracts the value of attribute <code>keyword</code> from the provided <code>value</code> for entity <code>entid</code>.</p>","parent_name":"InProgressBuilder"},"Classes/InProgressBuilder.html#/s:6Mentat17InProgressBuilderC7retractys5Int64V5entid_SS7keywordSb7booleantKF":{"name":"retract(entid:keyword:boolean:)","abstract":"<p>Retracts the value of attribute <code>keyword</code> from the provided <code>value</code> for entity <code>entid</code>.</p>","parent_name":"InProgressBuilder"},"Classes/InProgressBuilder.html#/s:6Mentat17InProgressBuilderC7retractys5Int64V5entid_SS7keywordSd6doubletKF":{"name":"retract(entid:keyword:double:)","abstract":"<p>Retracts the value of attribute <code>keyword</code> from the provided <code>value</code> for entity <code>entid</code>.</p>","parent_name":"InProgressBuilder"},"Classes/InProgressBuilder.html#/s:6Mentat17InProgressBuilderC7retractys5Int64V5entid_SS7keyword10Foundation4DateV4datetKF":{"name":"retract(entid:keyword:date:)","abstract":"<p>Retracts the value of attribute <code>keyword</code> from the provided <code>value</code> for entity <code>entid</code>.</p>","parent_name":"InProgressBuilder"},"Classes/InProgressBuilder.html#/s:6Mentat17InProgressBuilderC7retractys5Int64V5entid_SS7keywordSS6stringtKF":{"name":"retract(entid:keyword:string:)","abstract":"<p>Retracts the value of attribute <code>keyword</code> from the provided <code>value</code> for entity <code>entid</code>.</p>","parent_name":"InProgressBuilder"},"Classes/InProgressBuilder.html#/s:6Mentat17InProgressBuilderC7retractys5Int64V5entid_SS7keyword10Foundation4UUIDV4uuidtKF":{"name":"retract(entid:keyword:uuid:)","abstract":"<p>Retracts the value of attribute <code>keyword</code> from the provided <code>value</code> for entity <code>entid</code>.</p>","parent_name":"InProgressBuilder"},"Classes/InProgressBuilder.html#/s:6Mentat17InProgressBuilderC8transactAA0bC0C_AA8TxReportCSgtyKF":{"name":"transact()","abstract":"<p>Transacts the added assertions. This consumes the pointer associated with this <code>InProgressBuilder</code>","parent_name":"InProgressBuilder"},"Classes/InProgressBuilder.html#/s:6Mentat17InProgressBuilderC6commitAA8TxReportCyKF":{"name":"commit()","abstract":"<p>Transacts the added assertions and commits. This consumes the pointer associated with this <code>InProgressBuilder</code>","parent_name":"InProgressBuilder"},"Classes/InProgressBuilder.html#/s:6Mentat17InProgressBuilderC7cleanupys13OpaquePointerV7pointer_tF":{"name":"cleanup(pointer:)","abstract":"<p>Undocumented</p>","parent_name":"InProgressBuilder"},"Classes/InProgress.html#/s:6Mentat10InProgressC7builderAA0bC7BuilderCyKF":{"name":"builder()","abstract":"<p>Creates an <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/InProgressBuilder.html\">InProgressBuilder</a></code> using this <code>InProgress</code>.</p>","parent_name":"InProgress"},"Classes/InProgress.html#/s:6Mentat10InProgressC7builderAA13EntityBuilderCs5Int64V8forEntid_tKF":{"name":"builder(forEntid:)","abstract":"<p>Creates an <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/EntityBuilder.html\">EntityBuilder</a></code> using this <code>InProgress</code> for the entity with <code>entid</code>.</p>","parent_name":"InProgress"},"Classes/InProgress.html#/s:6Mentat10InProgressC7builderAA13EntityBuilderCSS9forTempId_tKF":{"name":"builder(forTempId:)","abstract":"<p>Creates an <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/EntityBuilder.html\">EntityBuilder</a></code> using this <code>InProgress</code> for a new entity with <code>tempId</code>.</p>","parent_name":"InProgress"},"Classes/InProgress.html#/s:6Mentat10InProgressC8transactAA8TxReportCSS11transaction_tKF":{"name":"transact(transaction:)","abstract":"<p>Transacts the <code>transaction</code></p>","parent_name":"InProgress"},"Classes/InProgress.html#/s:6Mentat10InProgressC6commityyKF":{"name":"commit()","abstract":"<pre class=\"highlight swift\"><code><span class=\"kt\">Commits</span> <span class=\"n\">all</span> <span class=\"n\">the</span> <span class=\"n\">transacts</span> <span class=\"n\">that</span> <span class=\"n\">have</span> <span class=\"n\">been</span> <span class=\"n\">performed</span> <span class=\"n\">on</span> <span class=\"n\">this</span> <span class=\"p\">`</span><span class=\"nv\">InProgress</span><span class=\"p\">`,</span> <span class=\"n\">either</span> <span class=\"n\">directly</span>","parent_name":"InProgress"},"Classes/InProgress.html#/s:6Mentat10InProgressC8rollbackyyKF":{"name":"rollback()","abstract":"<p>Rolls back all the transacts that have been performed on this <code>InProgress</code>, either directly","parent_name":"InProgress"},"Classes/InProgress.html#/s:6Mentat10InProgressC7cleanupys13OpaquePointerV7pointer_tF":{"name":"cleanup(pointer:)","abstract":"<p>Undocumented</p>","parent_name":"InProgress"},"Classes/EntityBuilder.html#/s:6Mentat13EntityBuilderC3addySS7keyword_s5Int64V4longtKF":{"name":"add(keyword:long:)","abstract":"<p>Asserts the value of attribute <code>keyword</code> to be the provided <code>value</code>.</p>","parent_name":"EntityBuilder"},"Classes/EntityBuilder.html#/s:6Mentat13EntityBuilderC3addySS7keyword_s5Int64V9referencetKF":{"name":"add(keyword:reference:)","abstract":"<p>Asserts the value of attribute <code>keyword</code> to be the provided <code>value</code>.</p>","parent_name":"EntityBuilder"},"Classes/EntityBuilder.html#/s:6Mentat13EntityBuilderC3addySS7keyword_SSAEtKF":{"name":"add(keyword:keyword:)","abstract":"<p>Asserts the value of attribute <code>keyword</code> to be the provided <code>value</code>.</p>","parent_name":"EntityBuilder"},"Classes/EntityBuilder.html#/s:6Mentat13EntityBuilderC3addySS7keyword_Sb7booleantKF":{"name":"add(keyword:boolean:)","abstract":"<p>Asserts the value of attribute <code>keyword</code> to be the provided <code>value</code>.</p>","parent_name":"EntityBuilder"},"Classes/EntityBuilder.html#/s:6Mentat13EntityBuilderC3addySS7keyword_Sd6doubletKF":{"name":"add(keyword:double:)","abstract":"<p>Asserts the value of attribute <code>keyword</code> to be the provided <code>value</code>.</p>","parent_name":"EntityBuilder"},"Classes/EntityBuilder.html#/s:6Mentat13EntityBuilderC3addySS7keyword_10Foundation4DateV4datetKF":{"name":"add(keyword:date:)","abstract":"<p>Asserts the value of attribute <code>keyword</code> to be the provided <code>value</code>.</p>","parent_name":"EntityBuilder"},"Classes/EntityBuilder.html#/s:6Mentat13EntityBuilderC3addySS7keyword_SS6stringtKF":{"name":"add(keyword:string:)","abstract":"<p>Asserts the value of attribute <code>keyword</code> to be the provided <code>value</code>.</p>","parent_name":"EntityBuilder"},"Classes/EntityBuilder.html#/s:6Mentat13EntityBuilderC3addySS7keyword_10Foundation4UUIDV4uuidtKF":{"name":"add(keyword:uuid:)","abstract":"<p>Asserts the value of attribute <code>keyword</code> to be the provided <code>value</code>.</p>","parent_name":"EntityBuilder"},"Classes/EntityBuilder.html#/s:6Mentat13EntityBuilderC7retractySS7keyword_s5Int64V4longtKF":{"name":"retract(keyword:long:)","abstract":"<p>Retracts the value of attribute <code>keyword</code> from the provided <code>value</code>.</p>","parent_name":"EntityBuilder"},"Classes/EntityBuilder.html#/s:6Mentat13EntityBuilderC7retractySS7keyword_s5Int64V9referencetKF":{"name":"retract(keyword:reference:)","abstract":"<p>Retracts the value of attribute <code>keyword</code> from the provided <code>value</code>.</p>","parent_name":"EntityBuilder"},"Classes/EntityBuilder.html#/s:6Mentat13EntityBuilderC7retractySS7keyword_SSAEtKF":{"name":"retract(keyword:keyword:)","abstract":"<p>Retracts the value of attribute <code>keyword</code> from the provided <code>value</code>.</p>","parent_name":"EntityBuilder"},"Classes/EntityBuilder.html#/s:6Mentat13EntityBuilderC7retractySS7keyword_Sb7booleantKF":{"name":"retract(keyword:boolean:)","abstract":"<p>Retracts the value of attribute <code>keyword</code> from the provided <code>value</code>.</p>","parent_name":"EntityBuilder"},"Classes/EntityBuilder.html#/s:6Mentat13EntityBuilderC7retractySS7keyword_Sd6doubletKF":{"name":"retract(keyword:double:)","abstract":"<p>Retracts the value of attribute <code>keyword</code> from the provided <code>value</code>.</p>","parent_name":"EntityBuilder"},"Classes/EntityBuilder.html#/s:6Mentat13EntityBuilderC7retractySS7keyword_10Foundation4DateV4datetKF":{"name":"retract(keyword:date:)","abstract":"<p>Retracts the value of attribute <code>keyword</code> from the provided <code>value</code>.</p>","parent_name":"EntityBuilder"},"Classes/EntityBuilder.html#/s:6Mentat13EntityBuilderC7retractySS7keyword_SS6stringtKF":{"name":"retract(keyword:string:)","abstract":"<p>Retracts the value of attribute <code>keyword</code> from the provided <code>value</code>.</p>","parent_name":"EntityBuilder"},"Classes/EntityBuilder.html#/s:6Mentat13EntityBuilderC7retractySS7keyword_10Foundation4UUIDV4uuidtKF":{"name":"retract(keyword:uuid:)","abstract":"<p>Retracts the value of attribute <code>keyword</code> from the provided <code>value</code>.</p>","parent_name":"EntityBuilder"},"Classes/EntityBuilder.html#/s:6Mentat13EntityBuilderC8transactAA10InProgressC_AA8TxReportCSgtyKF":{"name":"transact()","abstract":"<p>Transacts the added assertions. This consumes the pointer associated with this <code>EntityBuilder</code>","parent_name":"EntityBuilder"},"Classes/EntityBuilder.html#/s:6Mentat13EntityBuilderC6commitAA8TxReportCyKF":{"name":"commit()","abstract":"<p>Transacts the added assertions and commits. This consumes the pointer associated with this <code>EntityBuilder</code>","parent_name":"EntityBuilder"},"Classes/EntityBuilder.html#/s:6Mentat13EntityBuilderC7cleanupys13OpaquePointerV7pointer_tF":{"name":"cleanup(pointer:)","abstract":"<p>Undocumented</p>","parent_name":"EntityBuilder"},"Classes/RustObject.html#/s:6Mentat10RustObjectCACs13OpaquePointerV3raw_tcfc":{"name":"init(raw:)","abstract":"<p>Undocumented</p>","parent_name":"RustObject"},"Classes/RustObject.html#/s:6Mentat10RustObjectCACSv3raw_tcfc":{"name":"init(raw:)","abstract":"<p>Undocumented</p>","parent_name":"RustObject"},"Classes/RustObject.html#/s:6Mentat10RustObjectCACSgs13OpaquePointerVSg3raw_tcfc":{"name":"init(raw:)","abstract":"<p>Undocumented</p>","parent_name":"RustObject"},"Classes/RustObject.html#/s:6Mentat10RustObjectC6getRaws13OpaquePointerVyF":{"name":"getRaw()","abstract":"<p>Undocumented</p>","parent_name":"RustObject"},"Classes/RustObject.html#/s:6Mentat10RustObjectC7cleanupys13OpaquePointerV7pointer_tF":{"name":"cleanup(pointer:)","abstract":"<p>Undocumented</p>","parent_name":"RustObject"},"Classes/OptionalRustObject.html#/s:6Mentat18OptionalRustObjectCACSv3raw_tcfc":{"name":"init(raw:)","abstract":"<p>Undocumented</p>","parent_name":"OptionalRustObject"},"Classes/OptionalRustObject.html#/s:6Mentat18OptionalRustObjectCACs13OpaquePointerVSg3raw_tcfc":{"name":"init(raw:)","abstract":"<p>Undocumented</p>","parent_name":"OptionalRustObject"},"Classes/OptionalRustObject.html#/s:6Mentat18OptionalRustObjectC6getRaws13OpaquePointerVSgyF":{"name":"getRaw()","abstract":"<p>Undocumented</p>","parent_name":"OptionalRustObject"},"Classes/OptionalRustObject.html#/s:6Mentat18OptionalRustObjectC12validPointers06OpaqueF0VyKF":{"name":"validPointer()","abstract":"<p>Provides a non-optional <code>OpaquePointer</code> if one exists for this class.</p>","parent_name":"OptionalRustObject"},"Classes/OptionalRustObject.html#/s:6Mentat18OptionalRustObjectC7cleanupys13OpaquePointerV7pointer_tF":{"name":"cleanup(pointer:)","abstract":"<p>Undocumented</p>","parent_name":"OptionalRustObject"},"Classes/ColResultIterator.html#/s:s16IteratorProtocolP7Element":{"name":"Element","parent_name":"ColResultIterator"},"Classes/ColResultIterator.html#/s:s16IteratorProtocolP4next7ElementQzSgyF":{"name":"next()","parent_name":"ColResultIterator"},"Classes/ColResultIterator.html#/s:6Mentat17ColResultIteratorC7cleanupys13OpaquePointerV7pointer_tF":{"name":"cleanup(pointer:)","abstract":"<p>Undocumented</p>","parent_name":"ColResultIterator"},"Classes/ColResult.html#/s:s8SequenceP12makeIterator0C0QzyF":{"name":"makeIterator()","parent_name":"ColResult"},"Classes/TupleResult.html#/s:6Mentat11TupleResultC3getAA10TypedValueCSi5index_tF":{"name":"get(index:)","abstract":"<p>Return the <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/TypedValue.html\">TypedValue</a></code> at the specified index.","parent_name":"TupleResult"},"Classes/TupleResult.html#/s:6Mentat11TupleResultC6asLongs5Int64VSi5index_tF":{"name":"asLong(index:)","abstract":"<p>Return the <code>Int64</code> at the specified index.","parent_name":"TupleResult"},"Classes/TupleResult.html#/s:6Mentat11TupleResultC7asEntids5Int64VSi5index_tF":{"name":"asEntid(index:)","abstract":"<p>Return the <code><a href=\"36f8f5912051ae747ef441d6511ca4cbTypealiases.html#/s:6Mentat5Entida\">Entid</a></code> at the specified index.","parent_name":"TupleResult"},"Classes/TupleResult.html#/s:6Mentat11TupleResultC9asKeywordSSSi5index_tF":{"name":"asKeyword(index:)","abstract":"<p>Return the keyword <code>String</code> at the specified index.","parent_name":"TupleResult"},"Classes/TupleResult.html#/s:6Mentat11TupleResultC6asBoolSbSi5index_tF":{"name":"asBool(index:)","abstract":"<p>Return the <code>Bool</code> at the specified index.","parent_name":"TupleResult"},"Classes/TupleResult.html#/s:6Mentat11TupleResultC8asDoubleSdSi5index_tF":{"name":"asDouble(index:)","abstract":"<p>Return the <code>Double</code> at the specified index.","parent_name":"TupleResult"},"Classes/TupleResult.html#/s:6Mentat11TupleResultC6asDate10Foundation0E0VSi5index_tF":{"name":"asDate(index:)","abstract":"<p>Return the <code>Date</code> at the specified index.","parent_name":"TupleResult"},"Classes/TupleResult.html#/s:6Mentat11TupleResultC8asStringSSSi5index_tF":{"name":"asString(index:)","abstract":"<p>Return the <code>String</code> at the specified index.","parent_name":"TupleResult"},"Classes/TupleResult.html#/s:6Mentat11TupleResultC6asUUID10Foundation0E0VSgSi5index_tF":{"name":"asUUID(index:)","abstract":"<p>Return the <code>UUID</code> at the specified index.","parent_name":"TupleResult"},"Classes/TupleResult.html#/s:6Mentat11TupleResultC7cleanupys13OpaquePointerV7pointer_tF":{"name":"cleanup(pointer:)","abstract":"<p>Undocumented</p>","parent_name":"TupleResult"},"Classes/RelResultIterator.html#/s:s16IteratorProtocolP7Element":{"name":"Element","parent_name":"RelResultIterator"},"Classes/RelResultIterator.html#/s:s16IteratorProtocolP4next7ElementQzSgyF":{"name":"next()","parent_name":"RelResultIterator"},"Classes/RelResultIterator.html#/s:6Mentat17RelResultIteratorC7cleanupys13OpaquePointerV7pointer_tF":{"name":"cleanup(pointer:)","abstract":"<p>Undocumented</p>","parent_name":"RelResultIterator"},"Classes/RelResult.html#/s:6Mentat9RelResultC3rowAA05TupleC0CSgs5Int32V5index_tKF":{"name":"row(index:)","abstract":"<p>Fetch the row at the requested index.</p>","parent_name":"RelResult"},"Classes/RelResult.html#/s:6Mentat9RelResultC7cleanupys13OpaquePointerV7pointer_tF":{"name":"cleanup(pointer:)","abstract":"<p>Undocumented</p>","parent_name":"RelResult"},"Classes/RelResult.html#/s:s8SequenceP12makeIterator0C0QzyF":{"name":"makeIterator()","parent_name":"RelResult"},"Classes/Query.html#/s:6Mentat5QueryC4bindACSS7varName_s5Int64V6toLongtKF":{"name":"bind(varName:toLong:)","abstract":"<p>Binds a <code>Int64</code> value to the provided variable name.</p>","parent_name":"Query"},"Classes/Query.html#/s:6Mentat5QueryC4bindACSS7varName_s5Int64V11toReferencetKF":{"name":"bind(varName:toReference:)","abstract":"<p>Binds a <code><a href=\"36f8f5912051ae747ef441d6511ca4cbTypealiases.html#/s:6Mentat5Entida\">Entid</a></code> value to the provided variable name.</p>","parent_name":"Query"},"Classes/Query.html#/s:6Mentat5QueryC4bindACSS7varName_SS11toReferencetKF":{"name":"bind(varName:toReference:)","abstract":"<p>Binds a <code>String</code> value representing a keyword for an attribute to the provided variable name.","parent_name":"Query"},"Classes/Query.html#/s:6Mentat5QueryC4bindACSS7varName_SS9toKeywordtKF":{"name":"bind(varName:toKeyword:)","abstract":"<p>Binds a keyword <code>String</code> value to the provided variable name.","parent_name":"Query"},"Classes/Query.html#/s:6Mentat5QueryC4bindACSS7varName_Sb9toBooleantKF":{"name":"bind(varName:toBoolean:)","abstract":"<p>Binds a <code>Bool</code> value to the provided variable name.</p>","parent_name":"Query"},"Classes/Query.html#/s:6Mentat5QueryC4bindACSS7varName_Sd8toDoubletKF":{"name":"bind(varName:toDouble:)","abstract":"<p>Binds a <code>Double</code> value to the provided variable name.</p>","parent_name":"Query"},"Classes/Query.html#/s:6Mentat5QueryC4bindACSS7varName_10Foundation4DateV02toG0tKF":{"name":"bind(varName:toDate:)","abstract":"<p>Binds a <code>Date</code> value to the provided variable name.</p>","parent_name":"Query"},"Classes/Query.html#/s:6Mentat5QueryC4bindACSS7varName_SS8toStringtKF":{"name":"bind(varName:toString:)","abstract":"<p>Binds a <code>String</code> value to the provided variable name.</p>","parent_name":"Query"},"Classes/Query.html#/s:6Mentat5QueryC4bindACSS7varName_10Foundation4UUIDV6toUuidtKF":{"name":"bind(varName:toUuid:)","abstract":"<p>Binds a <code>UUID</code> value to the provided variable name.</p>","parent_name":"Query"},"Classes/Query.html#/s:6Mentat5QueryC3runyyAA9RelResultCSgc8callback_tKF":{"name":"run(callback:)","abstract":"<p>Execute the query with the values bound associated with this <code>Query</code> and call the provided callback function with the results as a list of rows of <code>TypedValues</code>.</p>","parent_name":"Query"},"Classes/Query.html#/s:6Mentat5QueryC9runScalaryyAA10TypedValueCSgc8callback_tKF":{"name":"runScalar(callback:)","abstract":"<p>Execute the query with the values bound associated with this <code>Query</code> and call the provided callback function with the result as a single <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/TypedValue.html\">TypedValue</a></code>.</p>","parent_name":"Query"},"Classes/Query.html#/s:6Mentat5QueryC7runCollyyAA9ColResultCSgc8callback_tKF":{"name":"runColl(callback:)","abstract":"<p>Execute the query with the values bound associated with this <code>Query</code> and call the provided callback function with the result as a list of single <code>TypedValues</code>.</p>","parent_name":"Query"},"Classes/Query.html#/s:6Mentat5QueryC8runTupleyyAA0D6ResultCSgc8callback_tKF":{"name":"runTuple(callback:)","abstract":"<p>Execute the query with the values bound associated with this <code>Query</code> and call the provided callback function with the result as a list of single <code>TypedValues</code>.</p>","parent_name":"Query"},"Classes/Query.html#/s:6Mentat5QueryC7cleanupys13OpaquePointerV7pointer_tF":{"name":"cleanup(pointer:)","abstract":"<p>Undocumented</p>","parent_name":"Query"},"Classes/Mentat.html#/s:6MentatAACABs13OpaquePointerV3raw_tcfc":{"name":"init(raw:)","abstract":"<p>Create a new Mentat with the provided pointer to a Mentat Store</p>","parent_name":"Mentat"},"Classes/Mentat.html#/s:6MentatAACABSS8storeURI_tcfc":{"name":"init(storeURI:)","abstract":"<p>Open a connection to a Store in a given location.","parent_name":"Mentat"},"Classes/Mentat.html#/s:6MentatAAC5cacheySS9attribute_AA14CacheDirectionO9directiontKF":{"name":"cache(attribute:direction:)","abstract":"<p>Add an attribute to the cache. The {@link CacheDirection} determines how that attribute can be","parent_name":"Mentat"},"Classes/Mentat.html#/s:6MentatAAC8transactAA8TxReportCSS11transaction_tKF":{"name":"transact(transaction:)","abstract":"<p>Simple transact of an EDN string.</p>","parent_name":"Mentat"},"Classes/Mentat.html#/s:6MentatAAC16beginTransactionAA10InProgressCyKF":{"name":"beginTransaction()","abstract":"<p>Start a new transaction.</p>","parent_name":"Mentat"},"Classes/Mentat.html#/s:6MentatAAC13entityBuilderAA010InProgressC0CyKF":{"name":"entityBuilder()","abstract":"<p>Creates a new transaction (<code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/InProgress.html\">InProgress</a></code>) and returns an <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/InProgressBuilder.html\">InProgressBuilder</a></code> for that transaction.</p>","parent_name":"Mentat"},"Classes/Mentat.html#/s:6MentatAAC13entityBuilderAA06EntityC0Cs5Int64V8forEntid_tKF":{"name":"entityBuilder(forEntid:)","abstract":"<p>Creates a new transaction (<code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/InProgress.html\">InProgress</a></code>) and returns an <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/EntityBuilder.html\">EntityBuilder</a></code> for the entity with <code>entid</code>","parent_name":"Mentat"},"Classes/Mentat.html#/s:6MentatAAC13entityBuilderAA06EntityC0CSS9forTempId_tKF":{"name":"entityBuilder(forTempId:)","abstract":"<p>Creates a new transaction (<code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/InProgress.html\">InProgress</a></code>) and returns an <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/EntityBuilder.html\">EntityBuilder</a></code> for a new entity with <code>tempId</code>","parent_name":"Mentat"},"Classes/Mentat.html#/s:6MentatAAC17entidForAttributes5Int64VSS9attribute_tF":{"name":"entidForAttribute(attribute:)","abstract":"<p>Get the the <code><a href=\"36f8f5912051ae747ef441d6511ca4cbTypealiases.html#/s:6Mentat5Entida\">Entid</a></code> of the attribute.</p>","parent_name":"Mentat"},"Classes/Mentat.html#/s:6MentatAAC5queryAA5QueryCSSAC_tF":{"name":"query(query:)","abstract":"<p>Start a query.</p>","parent_name":"Mentat"},"Classes/Mentat.html#/s:6MentatAAC5valueAA10TypedValueCSgSS12forAttribute_s5Int64V8ofEntitytKF":{"name":"value(forAttribute:ofEntity:)","abstract":"<p>Retrieve a single value of an attribute for an Entity</p>","parent_name":"Mentat"},"Classes/Mentat.html#/s:6MentatAAC7cleanupys13OpaquePointerV7pointer_tF":{"name":"cleanup(pointer:)","abstract":"<p>Undocumented</p>","parent_name":"Mentat"},"Classes/Mentat.html#/s:6MentatAAC8registerySS3key_AA9Observing_p8observerSaySSG10attributestF":{"name":"register(key:observer:attributes:)","abstract":"<p>Register an <code><a href=\"36f8f5912051ae747ef441d6511ca4cbProtocols/Observing.html\">Observing</a></code> and a set of attributes to observer for transaction observation.","parent_name":"Mentat"},"Classes/Mentat.html#/s:6MentatAAC10unregisterySS3key_tF":{"name":"unregister(key:)","abstract":"<p>Unregister the <code><a href=\"36f8f5912051ae747ef441d6511ca4cbProtocols/Observing.html\">Observing</a></code> that was registered with the provided key such that it will no longer be called","parent_name":"Mentat"},"Classes/TypedValue.html#/s:6Mentat10TypedValueC6asLongs5Int64VyF":{"name":"asLong()","abstract":"<p>This value as a <code>Int64</code>. This function will panic if the <code>ValueType</code> of this <code>TypedValue</code>","parent_name":"TypedValue"},"Classes/TypedValue.html#/s:6Mentat10TypedValueC7asEntids5Int64VyF":{"name":"asEntid()","abstract":"<p>This value as an <code><a href=\"36f8f5912051ae747ef441d6511ca4cbTypealiases.html#/s:6Mentat5Entida\">Entid</a></code>. This function will panic if the <code>ValueType</code> of this <code>TypedValue</code>","parent_name":"TypedValue"},"Classes/TypedValue.html#/s:6Mentat10TypedValueC9asKeywordSSyF":{"name":"asKeyword()","abstract":"<p>This value as a keyword <code>String</code>. This function will panic if the <code>ValueType</code> of this <code>TypedValue</code>","parent_name":"TypedValue"},"Classes/TypedValue.html#/s:6Mentat10TypedValueC6asBoolSbyF":{"name":"asBool()","abstract":"<p>This value as a <code>Bool</code>. This function will panic if the <code>ValueType</code> of this <code>TypedValue</code>","parent_name":"TypedValue"},"Classes/TypedValue.html#/s:6Mentat10TypedValueC8asDoubleSdyF":{"name":"asDouble()","abstract":"<p>This value as a <code>Double</code>. This function will panic if the <code>ValueType</code> of this <code>TypedValue</code>","parent_name":"TypedValue"},"Classes/TypedValue.html#/s:6Mentat10TypedValueC6asDate10Foundation0E0VyF":{"name":"asDate()","abstract":"<p>This value as a <code>Date</code>. This function will panic if the <code>ValueType</code> of this <code>TypedValue</code>","parent_name":"TypedValue"},"Classes/TypedValue.html#/s:6Mentat10TypedValueC8asStringSSyF":{"name":"asString()","abstract":"<p>This value as a <code>String</code>. This function will panic if the <code>ValueType</code> of this <code>TypedValue</code>","parent_name":"TypedValue"},"Classes/TypedValue.html#/s:6Mentat10TypedValueC6asUUID10Foundation0E0VSgyF":{"name":"asUUID()","abstract":"<p>This value as a <code>UUID</code>. This function will panic if the <code>ValueType</code> of this <code>TypedValue</code>","parent_name":"TypedValue"},"Classes/TypedValue.html#/s:6Mentat10TypedValueC7cleanupys13OpaquePointerV7pointer_tF":{"name":"cleanup(pointer:)","abstract":"<p>Undocumented</p>","parent_name":"TypedValue"},"Classes/TypedValue.html":{"name":"TypedValue","abstract":"<p>A wrapper around Mentat’s <code>TypedValue</code> Rust object. This class wraps a raw pointer to a Rust <code>TypedValue</code>"},"Classes/Mentat.html":{"name":"Mentat","abstract":"<p>The primary class for accessing Mentat’s API."},"Classes/Query.html":{"name":"Query","abstract":"<p>This class allows you to construct a query, bind values to variables and run those queries against a mentat DB.</p>"},"Classes/RelResult.html":{"name":"RelResult","abstract":"<p>Wraps a <code>Rel</code> result from a Mentat query."},"Classes/RelResultIterator.html":{"name":"RelResultIterator","abstract":"<p>Iterator for <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/RelResult.html\">RelResult</a></code>.</p>"},"Classes/TupleResult.html":{"name":"TupleResult","abstract":"<p>Wraps a <code>Tuple</code> result from a Mentat query."},"Classes/ColResult.html":{"name":"ColResult","abstract":"<p>Wraps a <code>Coll</code> result from a Mentat query."},"Classes/ColResultIterator.html":{"name":"ColResultIterator","abstract":"<p>Iterator for <code><a href=\"36f8f5912051ae747ef441d6511ca4cbClasses/ColResult.html\">ColResult</a></code>.</p>"},"Classes/OptionalRustObject.html":{"name":"OptionalRustObject","abstract":"<p>Base class that wraps an optional <code>OpaquePointer</code> representing a pointer to a Rust object."},"Classes/RustObject.html":{"name":"RustObject","abstract":"<p>Base class that wraps an non-optional <code>OpaquePointer</code> representing a pointer to a Rust object."},"Classes/EntityBuilder.html":{"name":"EntityBuilder","abstract":"<p>This class wraps a raw pointer that points to a Rust <code>EntityBuilder<InProgressBuilder></code> object.</p>"},"Classes/InProgress.html":{"name":"InProgress","abstract":"<p>This class wraps a raw pointer that points to a Rust <code>InProgress</code> object.</p>"},"Classes/InProgressBuilder.html":{"name":"InProgressBuilder","abstract":"<p>This class wraps a raw pointer that points to a Rust <code>InProgressBuilder</code> object.</p>"},"Classes/TxReport.html":{"name":"TxReport","abstract":"<p>This class wraps a raw pointer that points to a Rust <code>TxReport</code> object.</p>"},"Classes.html":{"name":"Classes","abstract":"<p>The following classes are available globally.</p>"},"Enums.html":{"name":"Enumerations","abstract":"<p>The following enumerations are available globally.</p>"},"Extensions.html":{"name":"Extensions","abstract":"<p>The following extensions are available globally.</p>"},"Protocols.html":{"name":"Protocols","abstract":"<p>The following protocols are available globally.</p>"},"Structs.html":{"name":"Structures","abstract":"<p>The following structures are available globally.</p>"},"Typealiases.html":{"name":"Type Aliases","abstract":"<p>The following type aliases are available globally.</p>"}} |