Byte Engine Docs
View on docs.rs

input

Generated Rust API reference for byte_engine.

byte_engine / input


Module input

Device-independent input actions and device registration.

Typical headed applications call setup_default_input, translate window events with process_default_window_input, and create application-level Action values through the graphics application's action factory. Use utils when registering the standard mouse, keyboard, or gamepad classes in a custom application.

InputManager owns device and action state. Value is the erased value passed through that runtime; typed action declarations use action::InputValue to constrain supported value types.

See Input for the device, trigger, action, and event workflow.

Contents

Quick Reference

ItemKindDescription
Axis2struct
Axis3struct
SeatHandlestruct
ValueMappingstructThe ValueMapping struct binds a trigger value to the transform used before action evaluation.
ActionEventstructThe ActionEvent struct carries resolved action input to application code.
TypesenumThe [Types] enum identifies the value representation accepted by input triggers and actions.
ValueenumThe [Value] enum carries device and action values through the non-generic input runtime.
FunctionenumThe Function enum identifies how an input value is transformed before it reaches an action.
TickPolicyenumThe TickPolicy enum controls how frequently an action emits events through the event channel.
ExtracttraitThe Extract trait recovers typed values from the input runtime's erased [Value] representation.

Structs

Axis2

struct Axis2 {
    pub x: f32,
    pub y: f32,
}

Defined in crates/byte-engine/src/input/axis.rs:13-18

The Axis2 struct carries a two-channel input value such as a mouse delta or gamepad stick.

Use Axis2 for device-relative values passed through super::Value. It deliberately has no world-space meaning. Next, use it in a super::input_trigger::TriggerDescription or an action super::ValueMapping.

Fields

  • x: f32

    The horizontal input channel.

  • y: f32

    The vertical input channel.

Implementations

  • const fn new(x: f32, y: f32) -> Self

    Creates a two-channel input value from its horizontal and vertical components.

  • const fn zero() -> Self

    Returns the neutral two-channel input value.

  • const fn min_value() -> Self

    Returns the lowest finite components accepted by input trigger descriptions.

  • const fn max_value() -> Self

    Returns the highest finite components accepted by input trigger descriptions.

  • fn normalized(self) -> Self

    Scales a non-zero axis to unit length while preserving a neutral axis.

Trait Implementations

impl Add for Axis2
  • type Output = Axis2
  • fn add(self, rhs: Self) -> <Self as >::Output
impl ArchivePointee for Axis2
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for Axis2
impl Clone for Axis2
  • fn clone(&self) -> Axis2

    Related: Axis2

impl Copy for Axis2
impl Debug for Axis2
  • fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Default for Axis2
  • fn default() -> Axis2

    Related: Axis2

impl Downcast for Axis2
  • 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 DowncastSend for Axis2
  • fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>
impl DowncastSync for Axis2
  • fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>
impl Extract for Value
  • fn extract(&self) -> Axis2

    Related: Axis2

impl Instrument for Axis2
impl LayoutRaw for Axis2
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for Axis2
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for Axis2
  • fn eq(&self, other: &Axis2) -> bool

    Related: Axis2

impl Pointable for Axis2
  • 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 Axis2
  • type Metadata = ()
impl Read for Axis2
impl<R> ReadPrimitive for Axis2
impl StructuralPartialEq for Axis2
impl WithSubscriber for Axis2

Axis3

struct Axis3 {
    pub x: f32,
    pub y: f32,
    pub z: f32,
}

Defined in crates/byte-engine/src/input/axis.rs:67-74

The Axis3 struct carries a three-channel input value such as a headset position or directional command.

Use Axis3 for device-relative values passed through super::Value. It deliberately has no world-space meaning. Next, use it in a super::input_trigger::TriggerDescription or an action super::ValueMapping.

Fields

  • x: f32

    The first input channel, conventionally horizontal.

  • y: f32

    The second input channel, conventionally vertical.

  • z: f32

    The third input channel, conventionally depth.

Implementations

  • const fn new(x: f32, y: f32, z: f32) -> Self

    Creates a three-channel input value from its components.

  • const fn zero() -> Self

    Returns the neutral three-channel input value.

  • const fn min_value() -> Self

    Returns the lowest finite components accepted by input trigger descriptions.

  • const fn max_value() -> Self

    Returns the highest finite components accepted by input trigger descriptions.

  • fn normalized(self) -> Self

    Scales a non-zero axis to unit length while preserving a neutral axis.

Trait Implementations

impl Add for Axis3
  • type Output = Axis3
  • fn add(self, rhs: Self) -> <Self as >::Output
impl ArchivePointee for Axis3
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for Axis3
impl Clone for Axis3
  • fn clone(&self) -> Axis3

    Related: Axis3

impl Copy for Axis3
impl Debug for Axis3
  • fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Default for Axis3
  • fn default() -> Axis3

    Related: Axis3

impl Downcast for Axis3
  • 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 DowncastSend for Axis3
  • fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>
impl DowncastSync for Axis3
  • fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>
impl Extract for Value
  • fn extract(&self) -> Axis3

    Related: Axis3

impl Instrument for Axis3
impl LayoutRaw for Axis3
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl Mul for Axis3
  • type Output = Axis3
  • fn mul(self, rhs: Self) -> <Self as >::Output
impl<T, N1> Niching for Axis3
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for Axis3
  • fn eq(&self, other: &Axis3) -> bool

    Related: Axis3

impl Pointable for Axis3
  • 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 Axis3
  • type Metadata = ()
impl Read for Axis3
impl<R> ReadPrimitive for Axis3
impl StructuralPartialEq for Axis3
impl WithSubscriber for Axis3

SeatHandle

struct SeatHandle();

Defined in crates/byte-engine/src/input/seat.rs:3

The SeatHandle struct identifies the player seat associated with input.

Implementations

  • fn stub() -> Self

    Returns the placeholder seat used until platform input seats are wired through.

Trait Implementations

impl ArchivePointee for SeatHandle
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for SeatHandle
impl Clone for SeatHandle
  • fn clone(&self) -> SeatHandle

    Related: SeatHandle

impl Copy for SeatHandle
impl Debug for SeatHandle
  • fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for SeatHandle
  • 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 DowncastSend for SeatHandle
  • fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>
impl DowncastSync for SeatHandle
  • fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>
impl Eq for SeatHandle
impl<K> Equivalent for SeatHandle
  • fn equivalent(&self, key: &K) -> bool
impl Hash for SeatHandle
  • fn hash<__H: hash::Hasher>(&self, state: &mut __H)
impl Instrument for SeatHandle
impl LayoutRaw for SeatHandle
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for SeatHandle
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for SeatHandle
  • fn eq(&self, other: &SeatHandle) -> bool

    Related: SeatHandle

impl Pointable for SeatHandle
  • 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 SeatHandle
  • type Metadata = ()
impl Read for SeatHandle
impl StructuralPartialEq for SeatHandle
impl WithSubscriber for SeatHandle

ValueMapping

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

Defined in crates/byte-engine/src/input/mod.rs:262-265

The ValueMapping struct binds a trigger value to the transform used before action evaluation.

From implementations for values use Function::Linear as the default transform, so callers can pass plain values when no custom mapping is needed.

Implementations

  • fn new<V: Into<Value>>(function: Function, value: V) -> Self

    Related: Function

    Creates a mapping from a transform function and a compatible input value.

  • fn function(self, function: Function) -> Self

    Related: Function

    Replaces the transform function used by this mapping.

  • fn value(self, value: Value) -> Self

    Related: Value

    Replaces the input value used by this mapping.

Trait Implementations

impl ArchivePointee for ValueMapping
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for ValueMapping
impl Clone for ValueMapping
impl Copy for ValueMapping
impl Debug for ValueMapping
  • fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for ValueMapping
  • 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 DowncastSend for ValueMapping
  • fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>
impl DowncastSync for ValueMapping
  • fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>
impl Instrument for ValueMapping
impl LayoutRaw for ValueMapping
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for ValueMapping
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for ValueMapping
  • fn eq(&self, other: &ValueMapping) -> bool

    Related: ValueMapping

impl Pointable for ValueMapping
  • 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 ValueMapping
  • type Metadata = ()
impl Read for ValueMapping
impl StructuralPartialEq for ValueMapping
impl WithSubscriber for ValueMapping

ActionEvent

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

Defined in crates/byte-engine/src/input/mod.rs:327-334

The ActionEvent struct carries resolved action input to application code.

Implementations

  • fn new(seat_handle: SeatHandle, handle: Handle, value: Value) -> Self

    Related: SeatHandle, Value

    Creates an action event for dispatch through the input event channel.

  • fn seat_handle(&self) -> SeatHandle

    Related: SeatHandle

    Returns the seat that produced the action value.

  • fn handle(&self) -> Handle

    Returns the action handle associated with the event.

  • fn value(&self) -> Value

    Related: Value

    Returns the resolved action value.

Trait Implementations

impl ArchivePointee for ActionEvent
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for ActionEvent
impl Clone for ActionEvent
impl Debug for ActionEvent
  • fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for ActionEvent
  • 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 DowncastSend for ActionEvent
  • fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>
impl DowncastSync for ActionEvent
  • fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>
impl Instrument for ActionEvent
impl LayoutRaw for ActionEvent
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for ActionEvent
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl Pointable for ActionEvent
  • 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 ActionEvent
  • type Metadata = ()
impl Read for ActionEvent
impl WithSubscriber for ActionEvent

Enums

Types

enum Types {
    Boolean,
    Unicode,
    Float,
    Int,
    Vector2,
    Vector3,
    Quaternion,
    Rgba,
}

Defined in crates/byte-engine/src/input/mod.rs:54-71

The Types enum identifies the value representation accepted by input triggers and actions.

Variants

  • Boolean

    A boolean value.

  • Unicode

    A Unicode character.

  • Float

    A floating point value.

  • Int

    An integer value.

  • Vector2

    A two-channel input value.

  • Vector3

    A three-channel input value.

  • Quaternion

    A quaternion.

  • Rgba

    An RGBA color value.

Implementations

  • fn default_value(&self) -> Value

    Related: Value

    Returns the neutral value used before a trigger or action produces input.

Trait Implementations

impl ArchivePointee for Types
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for Types
impl Clone for Types
  • fn clone(&self) -> Types

    Related: Types

impl Copy for Types
impl Debug for Types
  • fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for Types
  • 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 DowncastSend for Types
  • fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>
impl DowncastSync for Types
  • fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>
impl Eq for Types
impl<K> Equivalent for Types
  • fn equivalent(&self, key: &K) -> bool
impl Instrument for Types
impl LayoutRaw for Types
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for Types
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for Types
  • fn eq(&self, other: &Types) -> bool

    Related: Types

impl Pointable for Types
  • 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 Types
  • type Metadata = ()
impl Read for Types
impl StructuralPartialEq for Types
impl WithSubscriber for Types

Value

enum Value {
    Bool(bool),
    Unicode(char),
    Float(f32),
    Int(i32),
    Rgba(super::utils::RGBA),
    Vector2(Axis2),
    Vector3(Axis3),
    Quaternion(math::Quaternion),
}

Defined in crates/byte-engine/src/input/mod.rs:76-93

The Value enum carries device and action values through the non-generic input runtime.

Variants

  • Bool

    A boolean value.

  • Unicode

    A Unicode character.

  • Float

    A floating point value.

  • Int

    An integer value.

  • Rgba

    An RGBA color value.

  • Vector2

    A two-channel input value.

  • Vector3

    A 3D input value.

  • Quaternion

    A quaternion.

Implementations

  • fn is_default(&self) -> bool

    Returns true if this value is equal to the default value for its type.

    Used by TickPolicy::WhileActive to determine whether to emit events.

Trait Implementations

impl ArchivePointee for Value
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for Value
impl Clone for Value
  • fn clone(&self) -> Value

    Related: Value

impl Copy for Value
impl Debug for Value
  • fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for Value
  • 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 DowncastSend for Value
  • fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>
impl DowncastSync for Value
  • fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>
impl Extract for Value
  • fn extract(&self) -> bool
impl Instrument for Value
impl LayoutRaw for Value
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for Value
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for Value
  • fn eq(&self, other: &Value) -> bool

    Related: Value

impl Pointable for Value
  • 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 Value
  • type Metadata = ()
impl Read for Value
impl StructuralPartialEq for Value
impl WithSubscriber for Value

Function

enum Function {
    Boolean,
    Threshold,
    Linear,
    Sphere,
}

Defined in crates/byte-engine/src/input/mod.rs:195-204

The Function enum identifies how an input value is transformed before it reaches an action.

Variants

  • Boolean

    Treats the mapped input as an on/off value.

  • Threshold

    Converts the mapped input to a boolean using a threshold.

  • Linear

    Passes the mapped value through without curve-specific remapping.

  • Sphere

    Maps a 2D point to a 3D point on a sphere.

Trait Implementations

impl ArchivePointee for Function
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for Function
impl Clone for Function
  • fn clone(&self) -> Function

    Related: Function

impl Copy for Function
impl Debug for Function
  • fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Downcast for Function
  • 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 DowncastSend for Function
  • fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>
impl DowncastSync for Function
  • fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>
impl Eq for Function
impl<K> Equivalent for Function
  • fn equivalent(&self, key: &K) -> bool
impl Instrument for Function
impl LayoutRaw for Function
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for Function
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for Function
  • fn eq(&self, other: &Function) -> bool

    Related: Function

impl Pointable for Function
  • 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 Function
  • type Metadata = ()
impl Read for Function
impl StructuralPartialEq for Function
impl WithSubscriber for Function

TickPolicy

enum TickPolicy {
    OnChange,
    WhileActive,
    Always,
}

Defined in crates/byte-engine/src/input/mod.rs:211-220

The TickPolicy enum controls how frequently an action emits events through the event channel.

Applications use this policy to choose event-driven or poll-driven handling for each action.

Variants

  • OnChange

    Emits events only when a trigger value changes. This is the default.

  • WhileActive

    Emits events every frame while the action's resolved value is non-default (e.g. while a key is held, while a stick is displaced from center).

  • Always

    Emits events every frame, regardless of the action's current value.

Trait Implementations

impl ArchivePointee for TickPolicy
  • type ArchivedMetadata = ()
  • fn pointer_metadata(_: &<T as ArchivePointee>::ArchivedMetadata) -> <T as Pointee>::Metadata
impl<ST> CastableFrom for TickPolicy
impl Clone for TickPolicy
  • fn clone(&self) -> TickPolicy

    Related: TickPolicy

impl Copy for TickPolicy
impl Debug for TickPolicy
  • fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
impl Default for TickPolicy
impl Downcast for TickPolicy
  • 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 DowncastSend for TickPolicy
  • fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>
impl DowncastSync for TickPolicy
  • fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>
impl Eq for TickPolicy
impl<K> Equivalent for TickPolicy
  • fn equivalent(&self, key: &K) -> bool
impl Instrument for TickPolicy
impl LayoutRaw for TickPolicy
  • fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T, N1> Niching for TickPolicy
  • unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
  • fn resolve_niched(out: Place<NichedOption<T, N1>>)
impl PartialEq for TickPolicy
  • fn eq(&self, other: &TickPolicy) -> bool

    Related: TickPolicy

impl Pointable for TickPolicy
  • 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 TickPolicy
  • type Metadata = ()
impl Read for TickPolicy
impl<R> ReadPrimitive for TickPolicy
impl StructuralPartialEq for TickPolicy
impl WithSubscriber for TickPolicy

Traits

Extract<T: InputValue>

trait Extract<T: InputValue> { ... }

Defined in crates/byte-engine/src/input/mod.rs:224-227

The Extract trait recovers typed values from the input runtime's erased Value representation.

Required Methods

  • fn extract(&self) -> T

    Returns the stored value as the requested input type.

Implementors

On this page

Module inputContentsQuick ReferenceStructsAxis2FieldsImplementationsTrait Implementationsimpl Add for Axis2impl ArchivePointee for Axis2impl<ST> CastableFrom for Axis2impl Clone for Axis2impl Copy for Axis2impl Debug for Axis2impl Default for Axis2impl Downcast for Axis2impl DowncastSend for Axis2impl DowncastSync for Axis2impl Extract for Valueimpl Instrument for Axis2impl LayoutRaw for Axis2impl<T, N1> Niching for Axis2impl PartialEq for Axis2impl Pointable for Axis2impl Pointee for Axis2impl Read for Axis2impl<R> ReadPrimitive for Axis2impl StructuralPartialEq for Axis2impl WithSubscriber for Axis2Axis3FieldsImplementationsTrait Implementationsimpl Add for Axis3impl ArchivePointee for Axis3impl<ST> CastableFrom for Axis3impl Clone for Axis3impl Copy for Axis3impl Debug for Axis3impl Default for Axis3impl Downcast for Axis3impl DowncastSend for Axis3impl DowncastSync for Axis3impl Extract for Valueimpl Instrument for Axis3impl LayoutRaw for Axis3impl Mul for Axis3impl<T, N1> Niching for Axis3impl PartialEq for Axis3impl Pointable for Axis3impl Pointee for Axis3impl Read for Axis3impl<R> ReadPrimitive for Axis3impl StructuralPartialEq for Axis3impl WithSubscriber for Axis3SeatHandleImplementationsTrait Implementationsimpl ArchivePointee for SeatHandleimpl<ST> CastableFrom for SeatHandleimpl Clone for SeatHandleimpl Copy for SeatHandleimpl Debug for SeatHandleimpl Downcast for SeatHandleimpl DowncastSend for SeatHandleimpl DowncastSync for SeatHandleimpl Eq for SeatHandleimpl<K> Equivalent for SeatHandleimpl Hash for SeatHandleimpl Instrument for SeatHandleimpl LayoutRaw for SeatHandleimpl<T, N1> Niching for SeatHandleimpl PartialEq for SeatHandleimpl Pointable for SeatHandleimpl Pointee for SeatHandleimpl Read for SeatHandleimpl StructuralPartialEq for SeatHandleimpl WithSubscriber for SeatHandleValueMappingImplementationsTrait Implementationsimpl ArchivePointee for ValueMappingimpl<ST> CastableFrom for ValueMappingimpl Clone for ValueMappingimpl Copy for ValueMappingimpl Debug for ValueMappingimpl Downcast for ValueMappingimpl DowncastSend for ValueMappingimpl DowncastSync for ValueMappingimpl Instrument for ValueMappingimpl LayoutRaw for ValueMappingimpl<T, N1> Niching for ValueMappingimpl PartialEq for ValueMappingimpl Pointable for ValueMappingimpl Pointee for ValueMappingimpl Read for ValueMappingimpl StructuralPartialEq for ValueMappingimpl WithSubscriber for ValueMappingActionEventImplementationsTrait Implementationsimpl ArchivePointee for ActionEventimpl<ST> CastableFrom for ActionEventimpl Clone for ActionEventimpl Debug for ActionEventimpl Downcast for ActionEventimpl DowncastSend for ActionEventimpl DowncastSync for ActionEventimpl Instrument for ActionEventimpl LayoutRaw for ActionEventimpl<T, N1> Niching for ActionEventimpl Pointable for ActionEventimpl Pointee for ActionEventimpl Read for ActionEventimpl WithSubscriber for ActionEventEnumsTypesVariantsImplementationsTrait Implementationsimpl ArchivePointee for Typesimpl<ST> CastableFrom for Typesimpl Clone for Typesimpl Copy for Typesimpl Debug for Typesimpl Downcast for Typesimpl DowncastSend for Typesimpl DowncastSync for Typesimpl Eq for Typesimpl<K> Equivalent for Typesimpl Instrument for Typesimpl LayoutRaw for Typesimpl<T, N1> Niching for Typesimpl PartialEq for Typesimpl Pointable for Typesimpl Pointee for Typesimpl Read for Typesimpl StructuralPartialEq for Typesimpl WithSubscriber for TypesValueVariantsImplementationsTrait Implementationsimpl ArchivePointee for Valueimpl<ST> CastableFrom for Valueimpl Clone for Valueimpl Copy for Valueimpl Debug for Valueimpl Downcast for Valueimpl DowncastSend for Valueimpl DowncastSync for Valueimpl Extract for Valueimpl Instrument for Valueimpl LayoutRaw for Valueimpl<T, N1> Niching for Valueimpl PartialEq for Valueimpl Pointable for Valueimpl Pointee for Valueimpl Read for Valueimpl StructuralPartialEq for Valueimpl WithSubscriber for ValueFunctionVariantsTrait Implementationsimpl ArchivePointee for Functionimpl<ST> CastableFrom for Functionimpl Clone for Functionimpl Copy for Functionimpl Debug for Functionimpl Downcast for Functionimpl DowncastSend for Functionimpl DowncastSync for Functionimpl Eq for Functionimpl<K> Equivalent for Functionimpl Instrument for Functionimpl LayoutRaw for Functionimpl<T, N1> Niching for Functionimpl PartialEq for Functionimpl Pointable for Functionimpl Pointee for Functionimpl Read for Functionimpl StructuralPartialEq for Functionimpl WithSubscriber for FunctionTickPolicyVariantsTrait Implementationsimpl ArchivePointee for TickPolicyimpl<ST> CastableFrom for TickPolicyimpl Clone for TickPolicyimpl Copy for TickPolicyimpl Debug for TickPolicyimpl Default for TickPolicyimpl Downcast for TickPolicyimpl DowncastSend for TickPolicyimpl DowncastSync for TickPolicyimpl Eq for TickPolicyimpl<K> Equivalent for TickPolicyimpl Instrument for TickPolicyimpl LayoutRaw for TickPolicyimpl<T, N1> Niching for TickPolicyimpl PartialEq for TickPolicyimpl Pointable for TickPolicyimpl Pointee for TickPolicyimpl Read for TickPolicyimpl<R> ReadPrimitive for TickPolicyimpl StructuralPartialEq for TickPolicyimpl WithSubscriber for TickPolicyTraitsExtract<T: InputValue>Required MethodsImplementors