Byte Engine Docs
View on docs.rs

element

Generated Rust API reference for byte_engine.

byte_engine / ui / element


Module element

Concrete UI elements emitted by layout components.

Components typically construct elements through a crate::ui::layout::context::Context rather than using ConcreteElement directly. Implement Element for reusable element wrappers that expose a primitive.

Quick Reference

ItemKindDescription
ConcreteElementstructThe [ConcreteElement] struct stores one built-in primitive produced by a layout component.
ElementtraitThe [Element] trait exposes the primitive represented by a UI element.
ElementHandletraitThe [ElementHandle] trait exposes the stable identity assigned during layout.
IdtypeStable non-zero identifier assigned to UI elements during layout.

Structs

ConcreteElement

struct ConcreteElement {
    // [REDACTED: Private Fields]
}

Defined in crates/byte-engine/src/ui/element.rs:38-40

The ConcreteElement struct stores one built-in primitive produced by a layout component.

Implementations

  • fn container(container: Container) -> Self

    Related: Container

    Creates an element backed by a container primitive.

  • fn shape(shape: Shape) -> Self

    Creates an element backed by a shape primitive.

  • fn curve(curve: Curve) -> Self

    Related: Curve

    Creates an element backed by a curve primitive.

  • fn image(image: Image) -> Self

    Related: Image

    Creates an element backed by an image primitive.

  • fn text(text: Text) -> Self

    Related: Text

    Creates an element backed by a text primitive.

  • fn text_field(text_field: TextField) -> Self

    Related: TextField

    Creates an element backed by a text field primitive.

Trait Implementations

impl ArchivePointee for ConcreteElement
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for ConcreteElement
impl Downcast for ConcreteElement
  • fn into_any(self: Box<T>) -> Box<dyn Any>
  • fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
  • fn as_any(&self) -> &dyn Any
  • fn as_any_mut(&mut self) -> &mut dyn Any
impl Instrument for ConcreteElement
impl LayoutRaw for ConcreteElement
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for ConcreteElement
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl Pointable for ConcreteElement
  • const ALIGN: usize
  • type Init = T
  • unsafe fn init(init: <T as Pointable>::Init) -> usize
  • unsafe fn deref<'a>(ptr: usize) -> &'a T
  • unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
  • unsafe fn drop(ptr: usize)
impl Pointee for ConcreteElement
  • type Metadata = ()
impl Read for ConcreteElement
impl WithSubscriber for ConcreteElement

Traits

Element

trait Element { ... }

Defined in crates/byte-engine/src/ui/element.rs:20-23

The Element trait exposes the primitive represented by a UI element.

Required Methods

  • fn primitive(&self) -> BasePrimitive

    Returns the primitive that layout and rendering systems consume.

ElementHandle

trait ElementHandle { ... }

Defined in crates/byte-engine/src/ui/element.rs:31-34

The ElementHandle trait exposes the stable identity assigned during layout.

Required Methods

  • fn id(&self) -> Id

    Returns the layout identity for this element.

Type Aliases

Id

type Id = std::num::NonZeroU32;

Defined in crates/byte-engine/src/ui/element.rs:28

Stable non-zero identifier assigned to UI elements during layout.

On this page