Expand description
RAUI core types and components
The things that most users will be interested in here are the components. Those have more documentation on how to use widgets, components, etc. in your app.
Modules§
- animator
- Animation engine
- application
- Application foundation used to drive the RAUI interface
- gc
- Value boxes that tolerate reference cycles.
- interactive
- Interactivity traits
- layout
- Layout engine
- messenger
- Widget messaging
- props
- Widget property types
- renderer
- Renderer traits
- signals
- Widget signals
- state
- Widget state types
- tester
- value
- One enum over every way a value can be held.
- view_
model - widget
- Widget types and the core component collection
Macros§
- implement_
message_ data - Macro for implementing
MessageData. - implement_
props_ data - Macro for implementing
PropsData. - make_
widget - Helper to manually create a
WidgetComponentstruct from a function. - unpack_
named_ slots - A helper for getting the named children out of a widget context.
Structs§
- Dynamic
Managed - Owner of a value whose type is only known at runtime.
- Dynamic
Managed Gc - Type-erased garbage collected box.
- Dynamic
Managed Lazy - Unclaimed handle to a value whose type is only known at runtime.
- Dynamic
Managed Ref - Shared handle to a value whose type is only known at runtime.
- Dynamic
Managed RefMut - Exclusive handle to a value whose type is only known at runtime.
- Lifetime
- Owner of a runtime borrow state, kept next to the value it describes.
- Lifetime
Lazy - Handle that claims nothing until it is used.
- Lifetime
Ref - Shared borrow of a
Lifetime, the runtime analogue of&T. - Lifetime
RefMut - Mutable borrow of a
Lifetime, the runtime analogue of&mut T. - Lifetime
State - Cloneable strong handle to the counters behind a
Lifetime. - Lifetime
State Access - Guard over the internal spin lock of a
LifetimeState, through which the borrow and access counters are updated. - Lifetime
Weak State - Weak handle to a
LifetimeState, paired with the tag it was taken at. - Managed
- Owner of a value plus its runtime borrow state.
- Managed
Gc - Typed garbage collected box.
- Managed
Lazy - Unclaimed handle to a value owned by a
Managed. - Managed
Ref - Shared handle to a value owned by a
Managed, the runtime&T. - Managed
RefMut - Exclusive handle to a value owned by a
Managed, the runtime&mut T. - Prefab
Number - Represents a JSON number, whether integer or floating point.
- Print
Logger - Prints log messages to terminal via println! macro.
- Read
Lock - Read claim held without a reference to the value.
- Type
Hash - Runtime identity of a type, stored as a hash of its full type name.
- Value
Read Access - Read guard over a value, obtained from a lifetime or one of its handles.
- Value
Write Access - Write guard over a value, obtained from a lifetime or one of its handles.
- Write
Lock - Write claim held without a reference to the value.
Enums§
- Dynamic
Managed Value - A value of a runtime known type, held in any of the possible ways.
- LogKind
- Managed
GcLifetime - Borrow state of a garbage collected box, as seen from a handle.
- Managed
Value - A typed value held in any of the possible ways.
- Prefab
Error - An error that can occur while processing a
Prefab - Prefab
Value - Represents any valid JSON value.
Traits§
- Logger
- Common logging interface that custom log engines should follow to enable their reusability across different modules that will log messages to text output targets. Objects that implement this trait should be considered text output targets, for example text streams, terminal, network-based loggers, even application screen.
- Prefab
- The
Prefabtrait is implemented for types that are able to translate to and fromPrefabValue’s
Type Aliases§
Attribute Macros§
- post_
hooks - Allows you to execute re-usable logic after your component body
- pre_
hooks - An attribute macro that allows you to add hooks that will execute before your component body
Derive Macros§
- Message
Data - Derive macro for the [
MessageData][raui_core::messenger::MessageData] trait - Props
Data - Derive macro for the [
PropsData][raui_core::props::PropsData] trait