Pre-1.0: signatures are not frozen. Generated from rustdoc JSON of the compiled crate; rustdoc JSON format version 60. Only public items are listed.
Owned, bounded semantic policy tied to acknowledged facade frames.
This is a portable application/host contract, not an OS accessibility bridge. Supplied order is logical semantic order; omitted scene ancestors remain traversable and the nearest supplied ancestor becomes the semantic parent.
Structs
structaster_ui::semantics::AccessibilityPolicy
pub struct AccessibilityPolicy { /* see fields */ }Public fields
| field | type | |
|---|---|---|
text_scale | f64 | |
reduced_motion | bool | |
high_contrast | bool |
Trait implementations: Clone, Copy, Debug, Default, PartialEq, StructuralPartialEq
structaster_ui::semantics::ActionRequest
pub struct ActionRequest<'a> { /* see fields */ }Methods
fn snapshot(self) -> SnapshotIdfn presentation(self) -> PresentationIdfn frame(self) -> FrameReceiptfn node(self) -> NodeIdfn model_key(self) -> Option<ModelKey>fn action(self) -> Action<'a>
Trait implementations: Clone, Copy, Debug, PartialEq, StructuralPartialEq
structaster_ui::semantics::Actions
pub struct Actions(..)Methods
const NONE: Selffn with(self, action: ActionKind) -> Selffn contains(self, action: ActionKind) -> bool
Trait implementations: Clone, Copy, Debug, Default, Eq, PartialEq, StructuralPartialEq
structaster_ui::semantics::Description
pub struct Description<'a> { /* see fields */ }Intent metadata: the application must actually apply these policies to its layout/paint. Publishing this value does not change the rendered frame.
Public fields
| field | type | |
|---|---|---|
node | NodeId | |
role | Role | |
name | &'a str | |
description | &'a str | |
value | Option<&'a str> | |
numeric | Option<NumericValue> | |
state | State | |
actions | Actions |
Methods
fn new(node: NodeId, role: Role, name: &'a str) -> Self
Trait implementations: Clone, Copy, Debug
structaster_ui::semantics::Limits
pub struct Limits { /* see fields */ }Public fields
| field | type | |
|---|---|---|
nodes | usize | |
text_bytes | usize | Aggregate UTF-8 payload in each of the three store planes. |
ancestor_depth | usize | |
action_text_bytes | usize |
Trait implementations: Clone, Copy, Debug, Eq, PartialEq, StructuralPartialEq
structaster_ui::semantics::Node
pub struct Node<'a> { /* see fields */ }Methods
fn index(self) -> usizefn node_id(self) -> NodeIdfn model_key(self) -> Option<ModelKey>fn parent(self) -> Option<usize>fn role(self) -> Rolefn name(self) -> &'a strfn description(self) -> &'a strfn value(self) -> Option<&'a str>fn numeric(self) -> Option<NumericValue>fn state(self) -> Statefn effectively_hidden(self) -> boolfn actions(self) -> Actionsfn bounds(self) -> LogicalRectfn paint_map(self) -> Affine2D
Trait implementations: Clone, Copy
structaster_ui::semantics::NumericValue
pub struct NumericValue { /* see fields */ }Public fields
| field | type | |
|---|---|---|
value | f64 | |
min | f64 | |
max | f64 | |
step | f64 |
Trait implementations: Clone, Copy, Debug, PartialEq, StructuralPartialEq
structaster_ui::semantics::Presenter
pub struct Presenter { /* see fields */ }Three planes preserve accepted and pending output even when a new stage or
acknowledgement fails. All heap storage is admitted by new.
Methods
fn new(limits: Limits) -> Result<Self, SemanticError>fn limits(&self) -> Limitsfn storage(&self) -> StorageUsagefn stage(&mut self, scene: &Scene, frame: &Frame<'_>, descriptions: &[Description<'_>], policy: AccessibilityPolicy) -> Result<Ticket, SemanticError>fn stage_info(&mut self, scene: &Scene, frame: FrameInfo, descriptions: &[Description<'_>], policy: AccessibilityPolicy) -> Result<Ticket, SemanticError>— Stage accessibility from produced identity/geometry without borrowing pixels.fn acknowledge(&mut self, ticket: Ticket, input: &InputPresenter) -> Result<SnapshotId, SemanticError>fn snapshot(&self) -> Option<Snapshot<'_>>fn suspend(&mut self)fn action<'a>(&self, id: SnapshotId, node: NodeId, action: Action<'a>, input: &InputPresenter) -> Result<ActionRequest<'a>, SemanticError>— Produces a typed request only. No scene mutation, callback or automatic default action occurs. Applications resolve stale live model identities.
structaster_ui::semantics::Recording
pub struct Recording { /* see fields */ }Bounded owned historical copy for host recording/inspection. It supplies no action-dispatch method and retains no mutable scene or pixel resource.
Methods
fn new(nodes: usize, text_bytes: usize) -> Result<Self, SemanticError>fn capture(&mut self, snapshot: Snapshot<'_>) -> Result<(), SemanticError>fn snapshot(&self) -> Option<Snapshot<'_>>fn storage(&self) -> StorageUsage
structaster_ui::semantics::Snapshot
pub struct Snapshot<'a> { /* see fields */ }Methods
fn id(self) -> SnapshotIdfn frame(self) -> FrameReceiptfn presentation(self) -> PresentationIdfn policy(self) -> AccessibilityPolicyfn output(self) -> Outputfn len(self) -> usizefn is_empty(self) -> boolfn node(self, index: usize) -> Option<Node<'a>>fn find(self, node: NodeId) -> Option<Node<'a>>fn nodes(self) -> impl ExactSizeIterator<Item = Node<'a>>fn children(self, parent: Option<usize>) -> impl Iterator<Item = Node<'a>>
Trait implementations: Clone, Copy
structaster_ui::semantics::SnapshotId
pub struct SnapshotId { /* see fields */ }Trait implementations: Clone, Copy, Debug, Eq, PartialEq, StructuralPartialEq
structaster_ui::semantics::State
pub struct State { /* see fields */ }Public fields
| field | type | |
|---|---|---|
disabled | bool | |
hidden | bool | |
read_only | bool | |
focused | bool | |
selected | Option<bool> | |
checked | Option<Checked> | |
expanded | Option<bool> | |
invalid | bool | The value is refused by validation (a field showing an error). |
required | bool | The user must provide a value before the form can be submitted. |
Trait implementations: Clone, Copy, Debug, Default, Eq, PartialEq, StructuralPartialEq
structaster_ui::semantics::StorageUsage
pub struct StorageUsage { /* see fields */ }Public fields
| field | type | |
|---|---|---|
entry_bytes | usize | |
index_bytes | usize | |
text_bytes | usize | |
object_bytes | usize |
Trait implementations: Clone, Copy, Debug, Default, Eq, PartialEq, StructuralPartialEq
structaster_ui::semantics::Ticket
pub struct Ticket { /* see fields */ }Trait implementations: Clone, Copy, Debug, Eq, PartialEq, StructuralPartialEq
Enums
enumaster_ui::semantics::Action
pub enum Action<'a> { Activate, Focus, Increment, Decrement, SetValue, SetNumericValue, SetSelection }Methods
fn kind(self) -> ActionKind
Variants
ActivateFocusIncrementDecrementSetValueSetNumericValueSetSelection
Trait implementations: Clone, Copy, Debug, PartialEq, StructuralPartialEq
enumaster_ui::semantics::ActionKind
pub enum ActionKind { Activate, Focus, Increment, Decrement, SetValue, SetSelection }Variants
ActivateFocusIncrementDecrementSetValueSetSelection
Trait implementations: Clone, Copy, Debug, Eq, PartialEq, StructuralPartialEq
enumaster_ui::semantics::Checked
pub enum Checked { Off, On, Mixed }Variants
OffOnMixed
Trait implementations: Clone, Copy, Debug, Eq, PartialEq, StructuralPartialEq
enumaster_ui::semantics::Role
pub enum Role { Group, Text, Button, TextField, CheckBox, Slider, List, ListItem, Dialog, Image, Heading }Variants
GroupTextButtonTextFieldCheckBoxSliderListListItemDialogImageHeading— A heading of a document or a section, with its outline level (1 is the top; 0 when the level is unknown).
Trait implementations: Clone, Copy, Debug, Eq, PartialEq, StructuralPartialEq
enumaster_ui::semantics::SemanticError
pub enum SemanticError { Core, Capacity, TextCapacity, DepthLimit, DuplicateNode, InvalidPolicy, InvalidNumericValue, InvalidTextBoundary, StaleSnapshot, FrameMismatch, PresentationMismatch, NotInteractive, UnsupportedAction }Variants
CoreCapacityTextCapacityDepthLimitDuplicateNodeInvalidPolicyInvalidNumericValueInvalidTextBoundaryStaleSnapshotFrameMismatchPresentationMismatchNotInteractiveUnsupportedAction
Trait implementations: Clone, Copy, Debug, Display, Eq, Error, From<Error>, PartialEq, StructuralPartialEq