2018-06-25 10:20:36 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "generator" content = "rustdoc" >
< meta name = "description" content = "API documentation for the Rust `entities` mod in crate `edn`." >
< meta name = "keywords" content = "rust, rustlang, rust-lang, entities" >
< title > edn::entities - Rust< / title >
< link rel = "stylesheet" type = "text/css" href = "../../normalize.css" >
< link rel = "stylesheet" type = "text/css" href = "../../rustdoc.css"
id="mainThemeStyle">
< link rel = "stylesheet" type = "text/css" href = "../../dark.css" >
< link rel = "stylesheet" type = "text/css" href = "../../light.css" id = "themeStyle" >
< script src = "../../storage.js" > < / script >
< / head >
< body class = "rustdoc mod" >
<!-- [if lte IE 8]>
< div class = "warning" >
This old browser is unsupported and will most likely display funky
things.
< / div >
<![endif]-->
< nav class = "sidebar" >
< div class = "sidebar-menu" > ☰ < / div >
< p class = 'location' > Module entities< / p > < div class = "sidebar-elems" > < div class = "block items" > < ul > < li > < a href = "#structs" > Structs< / a > < / li > < li > < a href = "#enums" > Enums< / a > < / li > < li > < a href = "#types" > Type Definitions< / a > < / li > < / ul > < / div > < p class = 'location' > < a href = '../index.html' > edn< / a > < / p > < script > window . sidebarCurrent = { name : 'entities' , ty : 'mod' , relpath : '../' } ; < / script > < script defer src = "../sidebar-items.js" > < / script > < / div >
< / nav >
< div class = "theme-picker" >
< button id = "theme-picker" aria-label = "Pick another theme!" >
< img src = "../../brush.svg" width = "18" alt = "Pick another theme!" >
< / button >
< div id = "theme-choices" > < / div >
< / div >
< script src = "../../theme.js" > < / script >
< nav class = "sub" >
< form class = "search-form js-only" >
< div class = "search-container" >
< input class = "search-input" name = "search"
autocomplete="off"
placeholder="Click or press ‘ ’ ‘ ’
type="search">
< / div >
< / form >
< / nav >
< section id = 'main' class = "content" > < h1 class = 'fqn' > < span class = 'in-band' > Module < a href = '../index.html' > edn< / a > ::< wbr > < a class = "mod" href = '' > entities< / a > < / span > < span class = 'out-of-band' > < span id = 'render-detail' >
< a id = "toggle-all-docs" href = "javascript:void(0)" title = "collapse all docs" >
[< span class = 'inner' > − < / span > ]
< / a >
< / span > < a class = 'srclink' href = '../../src/edn/entities.rs.html#11-134' title = 'goto source code' > [src]< / a > < / span > < / h1 > < div class = 'docblock' > < p > This module defines core types that support the transaction processor.< / p >
< / div > < h2 id = 'structs' class = 'section-header' > < a href = "#structs" > Structs< / a > < / h2 >
< table >
< tr class = ' module-item' >
< td > < a class = "struct" href = "struct.LookupRef.html"
title='struct edn::entities::LookupRef'>LookupRef< / a > < / td >
< td class = 'docblock-short' >
< / td >
< / tr >
< tr class = ' module-item' >
< td > < a class = "struct" href = "struct.TxFunction.html"
title='struct edn::entities::TxFunction'>TxFunction< / a > < / td >
< td class = 'docblock-short' >
< p > A " transaction function" that exposes some value determined by the current transaction. The
prototypical example is the current transaction ID, < code > (transaction-tx)< / code > .< / p >
< / td >
< / tr > < / table > < h2 id = 'enums' class = 'section-header' > < a href = "#enums" > Enums< / a > < / h2 >
< table >
< tr class = ' module-item' >
< td > < a class = "enum" href = "enum.AttributePlace.html"
title='enum edn::entities::AttributePlace'>AttributePlace< / a > < / td >
< td class = 'docblock-short' >
< / td >
< / tr >
< tr class = ' module-item' >
2018-06-29 17:28:44 +00:00
< td > < a class = "enum" href = "enum.EntidOrIdent.html"
title='enum edn::entities::EntidOrIdent'>EntidOrIdent< / a > < / td >
2018-06-25 10:20:36 +00:00
< td class = 'docblock-short' >
< / td >
< / tr >
< tr class = ' module-item' >
< td > < a class = "enum" href = "enum.Entity.html"
title='enum edn::entities::Entity'>Entity< / a > < / td >
< td class = 'docblock-short' >
< / td >
< / tr >
< tr class = ' module-item' >
< td > < a class = "enum" href = "enum.EntityPlace.html"
title='enum edn::entities::EntityPlace'>EntityPlace< / a > < / td >
< td class = 'docblock-short' >
< / td >
< / tr >
< tr class = ' module-item' >
< td > < a class = "enum" href = "enum.OpType.html"
title='enum edn::entities::OpType'>OpType< / a > < / td >
< td class = 'docblock-short' >
< / td >
< / tr >
< tr class = ' module-item' >
< td > < a class = "enum" href = "enum.TempId.html"
title='enum edn::entities::TempId'>TempId< / a > < / td >
< td class = 'docblock-short' >
< p > A tempid, either an external tempid given in a transaction (usually as an < code > Value::Text< / code > ),
or an internal tempid allocated by Mentat itself.< / p >
< / td >
< / tr >
< tr class = ' module-item' >
< td > < a class = "enum" href = "enum.ValuePlace.html"
title='enum edn::entities::ValuePlace'>ValuePlace< / a > < / td >
< td class = 'docblock-short' >
< / td >
< / tr > < / table > < h2 id = 'types' class = 'section-header' > < a href = "#types" > Type Definitions< / a > < / h2 >
< table >
< tr class = ' module-item' >
< td > < a class = "type" href = "type.MapNotation.html"
title='type edn::entities::MapNotation'>MapNotation< / a > < / td >
< td class = 'docblock-short' >
< / td >
< / tr > < / table > < / section >
< section id = 'search' class = "content hidden" > < / section >
< section class = "footer" > < / section >
< aside id = "help" class = "hidden" >
< div >
< h1 class = "hidden" > Help< / h1 >
< div class = "shortcuts" >
< h2 > Keyboard Shortcuts< / h2 >
< dl >
< dt > < kbd > ?< / kbd > < / dt >
< dd > Show this help dialog< / dd >
< dt > < kbd > S< / kbd > < / dt >
< dd > Focus the search field< / dd >
< dt > < kbd > ↑< / kbd > < / dt >
< dd > Move up in search results< / dd >
< dt > < kbd > ↓< / kbd > < / dt >
< dd > Move down in search results< / dd >
< dt > < kbd > ↹< / kbd > < / dt >
< dd > Switch tab< / dd >
< dt > < kbd > ⏎ < / kbd > < / dt >
< dd > Go to active search result< / dd >
< dt > < kbd > +< / kbd > < / dt >
< dd > Expand all sections< / dd >
< dt > < kbd > -< / kbd > < / dt >
< dd > Collapse all sections< / dd >
< / dl >
< / div >
< div class = "infos" >
< h2 > Search Tricks< / h2 >
< p >
Prefix searches with a type followed by a colon (e.g.
< code > fn:< / code > ) to restrict the search to a given type.
< / p >
< p >
Accepted types are: < code > fn< / code > , < code > mod< / code > ,
< code > struct< / code > , < code > enum< / code > ,
< code > trait< / code > , < code > type< / code > , < code > macro< / code > ,
and < code > const< / code > .
< / p >
< p >
Search functions by type signature (e.g.
< code > vec -> usize< / code > or < code > * -> vec< / code > )
< / p >
< / div >
< / div >
< / aside >
< script >
window.rootPath = "../../";
window.currentCrate = "edn";
< / script >
< script src = "../../main.js" > < / script >
< script defer src = "../../search-index.js" > < / script >
< / body >
< / html >
