Expand description
euv-core
A declarative, cross-platform UI framework for Rust with virtual DOM, reactive signals, and HTML macros for WebAssembly.
Modules§
- Atomics
- The
Atomicsobject provides atomic operations as static methods. They are used withSharedArrayBufferobjects. - Intl
- JSON
- The
JSONobject contains methods for parsing JavaScript Object Notation (JSON) and converting values to JSON. It can’t be called or constructed, and aside from its two method properties, it has no interesting functionality of its own. - Math
- Reflect
- WebAssembly
- console
- futures
- Bridging between JavaScript
Promises and RustFutures. - js_sys
- Bindings to JavaScript’s standard, built-in objects, including their methods and properties.
- self
- Utilities for formatting and printing
Strings. - wasm_
bindgen - Runtime support for the
wasm-bindgentool
Structs§
- Aggregate
Error - The
AggregateErrorobject represents an error when several errors need to be wrapped in a single error. It is thrown when multiple errors need to be reported by an operation, for example byPromise::any, when all promises passed to it reject. - Animation
Event - The
AnimationEventclass. - App
- A zero-sized application context struct providing access to core euv framework APIs.
- Array
- Array
Buffer - Array
Buffer Options - Array
Into Iter - Iterator returned by
Array::into_iter - Array
Iter - Iterator returned by
Array::iter - Array
Tuple - Assert
Unwind Safe - A simple wrapper around a type to assert that it is unwind safe.
- Async
Generator - Async
Iterator - Any object that conforms to the JS async iterator protocol. For example,
something returned by
myObject[Symbol.asyncIterator](). - Attr
Value Adapter - Adapts an arbitrary attribute value expression into an
AttributeValue. - Attribute
Entry - Represents a single attribute on a virtual DOM node.
- Audio
Buffer - The
AudioBufferclass. - Audio
Buffer Source Node - The
AudioBufferSourceNodeclass. - Audio
Context - The
AudioContextclass. - Audio
Destination Node - The
AudioDestinationNodeclass. - Audio
Listener - The
AudioListenerclass. - Audio
Node - The
AudioNodeclass. - Audio
Param - The
AudioParamclass. - Audio
Scheduled Source Node - The
AudioScheduledSourceNodeclass. - Base
Audio Context - The
BaseAudioContextclass. - Before
Unload Event - The
BeforeUnloadEventclass. - BigInt
- BigInt64
Array - BigUint64
Array - Blob
- The
Blobclass. - Boolean
- Callback
Named Adapter - Adapts a callback with a custom name into an
AttributeValue. - Canvas
Gradient - The
CanvasGradientclass. - Canvas
Rendering Context2d - The
CanvasRenderingContext2dclass. - Character
Data - The
CharacterDataclass. - Charset
- Handles string encoding and decoding operations.
- Clipboard
- The
Clipboardclass. - Clipboard
Event - The
ClipboardEventclass. - Css
- Represents a CSS class with a name, its style declarations, and optional pseudo rules.
- CssStyle
Declaration - The
CssStyleDeclarationclass. - Data
Transfer - The
DataTransferclass. - Data
View - Date
- Default
Hasher - The default
Hasherused byRandomState. - Document
- The
Documentclass. - Document
Fragment - The
DocumentFragmentclass. - DomRect
- The
DomRectclass. - DomRect
Read Only - The
DomRectReadOnlyclass. - Drag
Event - The
DragEventclass. - Dynamic
Node - A closure-based dynamic node that re-renders when its dependency signals change.
- Element
- The
Elementclass. - Error
- Error
Options - The options dictionary accepted as the second argument to the
Errorconstructor (and other built-in error constructors such asAggregateError). Its sole standard property iscause, which indicates the original cause of the error. - Eval
Error - Event
- The
Eventclass. - Event
Adapter - Adapts various event value types into an
AttributeValuefor event attributes. - Event
Init - The
EventInitdictionary. - Event
Named Adapter - Adapts an event with a specific event name into an
AttributeValue. - Event
Source - The
EventSourceclass. - Event
Target - The
EventTargetclass. - File
- The
Fileclass. - File
List - The
FileListclass. - File
Reader - The
FileReaderclass. - Finalization
Registry - The
FinalizationRegistryobject lets you request a callback when an object is garbage-collected. - Fire
Handle - A handle to a leaked
FnMut()closure, stored as the closure’s heap address. - Float16
Array - Float32
Array - Float64
Array - Focus
Event - The
FocusEventclass. - Formatter
- Configuration for formatting.
- Function
Functionrepresents any generic Function in JS, by treating all arguments asJsValue.- Gain
Node - The
GainNodeclass. - Gamepad
- The
Gamepadclass. - Gamepad
Button - The
GamepadButtonclass. - Gamepad
Event - The
GamepadEventclass. - Generator
- Hash
Change Event - The
HashChangeEventclass. - HashMap
- A hash map implemented with quadratic probing and SIMD lookup.
- HashSet
- A hash set implemented as a
HashMapwhere the value is(). - History
- The
Historyclass. - Hook
Context - Manages hook state across render cycles for a DynamicNode.
- Hook
Context Inner - Internal storage for hook state, holding boxed
Anyvalues. - Html
Button Element - The
HtmlButtonElementclass. - Html
Canvas Element - The
HtmlCanvasElementclass. - Html
Collection - The
HtmlCollectionclass. - Html
Element - The
HtmlElementclass. - Html
Form Element - The
HtmlFormElementclass. - Html
Head Element - The
HtmlHeadElementclass. - Html
Image Element - The
HtmlImageElementclass. - Html
Input Element - The
HtmlInputElementclass. - Html
Media Element - The
HtmlMediaElementclass. - Html
Meta Element - The
HtmlMetaElementclass. - Html
Option Element - The
HtmlOptionElementclass. - Html
Select Element - The
HtmlSelectElementclass. - Html
Style Element - The
HtmlStyleElementclass. - Html
Text Area Element - The
HtmlTextAreaElementclass. - Html
Video Element - The
HtmlVideoElementclass. - Image
Data - The
ImageDataclass. - Inner
Html Adapter - Adapts an
inner_html:payload into the matchingAttributeValuevariant (InnerHtml(String)for static strings,InnerHtmlSignalforSignal<String>). - Input
Event - The
InputEventclass. - Int8
Array - Int16
Array - Int32
Array - Intersection
Observer - The
IntersectionObserverclass. - Intersection
Observer Entry - The
IntersectionObserverEntryclass. - Intersection
Observer Init - The
IntersectionObserverInitdictionary. - Interval
Handle - A handle to a browser interval timer created by
use_interval. - Into
Iter - An iterator over the JS
Symbol.iteratoriteration protocol. - Iter
- An iterator over the JS
Symbol.iteratoriteration protocol. - Iterator
- Any object that conforms to the JS iterator protocol. For example,
something returned by
myArray[Symbol.iterator](). - Iterator
Next - The result of calling
next()on a JS iterator. - JsError
- Convenience type for use on exported
fn() -> Result<T, JsError>functions, where you wish to throw a JavaScriptErrorobject. - JsNullable
- A nullable JS value of type
T. - JsOption
- An optional JS value of type
T. - JsString
- JsValue
- Representation of an object owned by JS.
- Keyboard
Event - The
KeyboardEventclass. - Lazy
Lock - A value which is initialized on the first access.
- Local
Key - A thread local storage (TLS) key which owns its contents.
- Location
- The
Locationclass. - LruCache
- A fixed-capacity LRU cache.
- Map
- Media
Devices - The
MediaDevicesclass. - Media
Query List - The
MediaQueryListclass. - Media
Rule - Represents a CSS @media rule attached to a class.
- Media
Stream - The
MediaStreamclass. - Media
Stream Constraints - The
MediaStreamConstraintsdictionary. - Media
Stream Track - The
MediaStreamTrackclass. - Message
Event - The
MessageEventclass. - Mouse
Event - The
MouseEventclass. - Native
Event Handler - A wrapper around an event callback.
- Navigator
- The
Navigatorclass. - Node
- The
Nodeclass. - Node
List - The
NodeListclass. - NodeRef
- A reactive handle to a mounted DOM element.
- Null
- The JavaScript
nullvalue. - Number
- Object
- Once
Lock - A synchronization primitive which can nominally be written to only once.
- Performance
- The
Performanceclass. - Phantom
Data - Zero-sized type used to mark things that “act like” they own a
T. - Promise
- The
Promiseobject represents the eventual completion (or failure) of an asynchronous operation, and its resulting value. - Promise
State - The
PromiseStateobject represents the the status of the promise, as used inallSettled. - Property
Descriptor - Proxy
- Pseudo
Rule - Represents a CSS pseudo-class or pseudo-element rule attached to a class.
- Range
Error - The
RangeErrorobject indicates an error when a value is not in the set or range of allowed values. - RawHtml
- A raw HTML string that the renderer must insert without escaping.
- Reference
Error - The
ReferenceErrorobject represents an error when a non-existent variable is referenced. - RegExp
- RegExp
Match Array - The result array from
RegExp.exec()orString.matchAll(). - Resize
Observer - The
ResizeObserverclass. - Resize
Observer Entry - The
ResizeObserverEntryclass. - Response
- The
Responseclass. - RwLock
- A reader-writer lock
- RwLock
Read Guard - RAII structure used to release the shared read access of a lock when dropped.
- Scoped
Closure - A closure with a lifetime parameter that represents a Rust closure passed to JavaScript.
- Scroll
Into View Options - The
ScrollIntoViewOptionsdictionary. - Set
- Shared
Array Buffer - Signal
- A reactive signal handle.
- Signal
Cell - A
Syncwrapper for single-threaded globalSignalaccess. - Storage
- The
Storageclass. - Submit
Event - The
SubmitEventclass. - Symbol
- Syntax
Error - A
SyntaxErroris thrown when the JavaScript engine encounters tokens or token order that does not conform to the syntax of the language when parsing code. - System
Time - The wall clock [
now_micros] reads on a host build. On wasm the clock comes from JS instead, so importing this there is anunused_importswarning — the mirror of the dead-const warning the host build would give the other half of the same function. A measurement of the system clock, useful for talking to external entities like the file system or other processes. - Text
- The
Textclass. - Text
Node - Represents a text node in the virtual DOM.
- Touch
- The
Touchclass. - Touch
Event - The
TouchEventclass. - Touch
List - The
TouchListclass. - Transition
Event - The
TransitionEventclass. - TryFrom
IntError - The error type returned when a checked integral type conversion fails.
- Type
Error - The
TypeErrorobject represents an error when a value is not of the expected type. - UiEvent
- The
UiEventclass. - Uint8
Array - Uint8
Clamped Array - Uint16
Array - Uint32
Array - Undefined
- The JavaScript
undefinedvalue. - UriError
- The
URIErrorobject represents an error when a global URI handling function was used in a wrong way. - VecDeque
- A double-ended queue implemented with a growable ring buffer.
- Visual
Viewport - The
VisualViewportclass. - WeakMap
- WeakRef
- WeakSet
- WebGl2
Rendering Context - The
WebGl2RenderingContextclass. - WebGl
Buffer - The
WebGlBufferclass. - WebGl
Context Attributes - The
WebGlContextAttributesdictionary. - WebGl
Framebuffer - The
WebGlFramebufferclass. - WebGl
Program - The
WebGlProgramclass. - WebGl
Renderbuffer - The
WebGlRenderbufferclass. - WebGl
Shader - The
WebGlShaderclass. - WebGl
Texture - The
WebGlTextureclass. - WebGl
Uniform Location - The
WebGlUniformLocationclass. - WebGl
Vertex Array Object - The
WebGlVertexArrayObjectclass. - WebSocket
- The
WebSocketclass. - Wheel
Event - The
WheelEventclass. - Window
- The
Windowclass.
Enums§
- Attribute
Value - Represents the value of an HTML attribute.
- Cow
- A clone-on-write smart pointer.
- Encode
Error - Represents errors that can occur during encoding.
- Scroll
Behavior - The
ScrollBehaviorenum. - Scroll
Logical Position - The
ScrollLogicalPositionenum. - Tag
- Represents the type of an HTML tag or a component.
- Virtual
Node - Represents a node in the virtual DOM tree.
Constants§
- UNIX_
EPOCH - The wall clock [
now_micros] reads on a host build. On wasm the clock comes from JS instead, so importing this there is anunused_importswarning — the mirror of the dead-const warning the host build would give the other half of the same function. An anchor in time which can be used to create newSystemTimeinstances or learn about where in time aSystemTimelies.
Traits§
- AsReactive
Text - Trait for types that can be converted into a reactive text
VirtualNode. - Async
Iterable - Trait for types known to implement the iterator protocol on Symbol.asyncIterator
- Debug
?formatting.- Display
- Format trait for an empty format,
{}. - Function
Into Closure - Hash
- A hashable type.
- Hasher
- A trait for hashing an arbitrary stream of bytes.
- Into
JsGeneric - Value conversion from a type into its canonical
JsGenericform. - Iterable
- Trait for JavaScript types that implement the iterable protocol via
Symbol.iterator. - JsArgs
- Trait for argument tuples that can call or bind a
Function<T>. - JsCast
- A trait for dynamic checked and unchecked casting between JS types.
- JsFunction
- JsFunction1
- JsFunction2
- JsFunction3
- JsFunction4
- JsFunction5
- JsFunction6
- JsFunction7
- JsFunction8
- JsGeneric
- A convenience trait for types that erase to
JsValue. - JsTuple
- Base trait for tuple types.
- JsTuple1
- JsTuple2
- JsTuple3
- JsTuple4
- JsTuple5
- JsTuple6
- JsTuple7
- JsTuple8
- Promising
- Marker trait for types which represent
ResolutionorPromise<Resolution>. - Typed
Array - Unwrap
Throw Ext - An extension trait for
Option<T>andResult<T, E>for unwrapping theTvalue, or throwing a JS error if it is not available. - Upcast
- A trait for type-safe generic upcasting.
Functions§
- catch_
unwind - Invokes a closure, capturing the cause of an unwinding panic if one occurs.
- decode_
uri - The
decodeURI()function decodes a Uniform Resource Identifier (URI) previously created byencodeURIor by a similar routine. - decode_
uri_ component - The
decodeURIComponent()function decodes a Uniform Resource Identifier (URI) component previously created byencodeURIComponentor by a similar routine. - encode_
uri - The
encodeURI()function encodes a Uniform Resource Identifier (URI) by replacing each instance of certain characters by one, two, three, or four escape sequences representing the UTF-8 encoding of the character (will only be four escape sequences for characters composed of two “surrogate” characters). - encode_
uri_ component - The
encodeURIComponent()function encodes a Uniform Resource Identifier (URI) component by replacing each instance of certain characters by one, two, three, or four escape sequences representing the UTF-8 encoding of the character (will only be four escape sequences for characters composed of two “surrogate” characters). - escape
- The
escape()function computes a new string in which certain characters have been replaced by a hexadecimal escape sequence. - eval
- The
eval()function evaluates JavaScript code represented as a string. - global
- Returns a handle to the global scope object.
- is_
finite - The global
isFinite()function determines whether the passed value is a finite number. If needed, the parameter is first converted to a number. - parse_
float - The
parseFloat()function parses an argument and returns a floating point number, or NaN on error. - parse_
int - The
parseInt()function parses a string argument and returns an integer of the specified radix (the base in mathematical numeral systems), or NaN on error. - swap
- Swaps the values at two mutable locations, without deinitializing either one.
- take
- Replaces
destwith the default value ofT, returning the previousdestvalue. - try_
iter - Create an iterator over
valusing the JS iteration protocol andSymbol.iterator. - unescape
- The
unescape()function computes a new string in which hexadecimal escape sequences are replaced with the character that it represents. The escape sequences might be introduced by a function likeescape. Usually,decodeURIordecodeURIComponentare preferred overunescape. - window
- Getter for the
Windowobject - zeroed⚠
- Returns the value of type
Trepresented by the all-zero byte-pattern.
Type Aliases§
- Closure
- Alias for
ScopedClosure<'static, T>for backwards compatibility. - Event
Callback - Type alias for an event callback closure.
- Node
RefDyn - Type-erased clone-able handle to a DOM element, used as the payload of
AttributeValue::Refso the renderer can populate the ref without committing to a concrete element type at attribute-set time. - Shared
Event Callback - Type alias for the shared, interior-mutable storage of an event callback.
- Text
Node Binder
Attribute Macros§
- __
wasm_ bindgen_ class_ marker - wasm_
bindgen - A list of all the attributes can be found here: https://wasm-bindgen.github.io/wasm-bindgen/reference/attributes/index.html
Derive Macros§
- Custom
Debug - A procedural macro that implements the
std::fmt::Debugtrait for a type, with support for the#[debug(skip)]attribute to skip specific fields. - Data
- A procedural macro that combines getter, mutable getter, and setter functionality in a single derive.
- Debug
- Derive macro generating an impl of the trait
Debug. - Display
Debug - A procedural macro that implements the
std::fmt::Displaytrait for a type, using the standard debug format ({:?}) for formatting. - Display
Debug Format - A procedural macro that implements the
std::fmt::Displaytrait for a type, using the detailed debug format ({:#?}) for formatting. - Getter
- A procedural macro that automatically generates getter methods for struct and enum fields.
- Getter
Mut - A procedural macro that automatically generates mutable getter methods for struct and enum fields.
- Hash
- Derive macro generating an impl of the trait
Hash. - New
- A procedural macro that generates a constructor function for structs.
- Setter
- A procedural macro that automatically generates setter methods for struct and enum fields.