Skip to main content

Module action_directory

Module action_directory 

Expand description

An application’s action directory, without the toolkit: the ActionDirectorySnapshot a publication of resources and actions builds, the bounded pages of it the broker asks for (a level, a named resource, or the actions a search names) and the exact row it resolves before an invocation.

The toolkit’s app framework (ui-core) builds its snapshot here and pages it, extending it with what only its widgets can say; an app host that publishes whole resource trees, as tilolang-host does, answers its connection’s directory with a PublishedDirectory alone.

Structs§

ActionDirectoryPage
ActionDirectoryQuery
Bounded, revision-aware request to an application-owned action directory.
ActionDirectoryRow
A hierarchy-preserving directory row. Resource rows have no action or descriptor; action rows contain the canonical descriptor for that exact resource/action address.
ActionDirectorySnapshot
The directory of one publication: its top level, each resource’s level, and each action’s row by address, in the tree order the publication declares them.
DirectoryNode
One resource’s directory level: its actions’ rows, then its children’s.
PublishedDirectory
The directory of a host that publishes its whole resource tree at once: the snapshot of what it last published, under a revision that changes whenever that does. Pages continue from a cursor that names the revision, the request and the offset, so it holds nothing per caller.

Enums§

ActionDirectoryResolution
Exact, current-authority response before an invocation is admitted.

Constants§

MAX_BYTES
The most bytes one page’s rows take on the wire.
MAX_DEPTH
The deepest level a directory discloses.
MAX_RESULTS
The most rows one page carries.
MAX_WORK
The most candidates one page inspects.
PAGE_WIRE_BYTES
What a page takes on the wire besides its rows.

Functions§

action_row_matches
Whether the action row carries is one a search for needle (already lowercase) finds: by its id, label, description, parameters’ names and descriptions, or its resource’s label.
exported_directory_action
The descriptor a directory row carries. Directory pages have never carried a resource view: the broker proves a view’s mount and range bindings against the actions on the same page, which a bounded page cannot promise, so views reach the shell through the published surface instead.
is_named
Whether a resource of kind labelled label is the one name names: by its kind exactly, or by its label ignoring ASCII case.
named_page
The one page a named lookup answers with: every row found holds, up to the query’s budgets, or none when they do not fit.
named_rows
The resource rows of snapshot that name names: at its top level for an empty parent, else on parent’s level. None when the snapshot does not hold parent.
stale_page
The page that says the caller’s revision or cursor is no longer current.
unavailable_page
The page that answers nothing: the directory cannot be read now.