Skip to main content

FieldContext

Struct FieldContext 

Source
pub struct FieldContext { /* private fields */ }
Expand description

Type-erased context for one field’s binding, metadata, and focus request slot.

The context itself is intentionally not generic. This lets use_binding distinguish an absent context from a present context containing the wrong value type, and lets Field accept any value type without becoming generic itself.

§Equality

Two contexts are equal when their bindings are equal under Binding’s identity equality and their metadata is equal, regardless of when either context was constructed. The focus request slot is intentionally excluded: Field pins the slot of the first context it receives for its lifetime, so the slot carried by a context built on a later render is never observed by descendants, and comparing it would only defeat memoization.

Implementations§

Source§

impl FieldContext

Source

pub fn new<T: 'static>(binding: Binding<T>) -> Self

Creates context for a binding.

Source

pub fn empty() -> Self

Creates context with no value binding or metadata.

Source

pub fn with_binding<T: 'static>(self, binding: Binding<T>) -> Self

Replaces the context’s value binding.

Source

pub fn with_meta(self, meta: FieldMeta) -> Self

Adds signal-backed metadata to the context.

Source

pub fn with_meta_values(self, values: FieldMetaValues) -> Self

Adds producer values that Field realizes as signal-backed metadata.

Source

pub fn meta(&self) -> Option<FieldMeta>

Returns the context’s metadata, when present.

Source

pub fn focus_request(&self) -> FocusRequest

Returns the context’s focus request slot.

Field pins the slot of the first context it receives, so producers that request focus through a context must keep that context stable across renders.

Source

pub fn resolve<T: 'static>(&self) -> Binding<T>

Resolves the context binding for T.

§Panics

Panics when the field context contains no binding or a binding for a different value type.

Trait Implementations§

Source§

impl Clone for FieldContext

Source§

fn clone(&self) -> FieldContext

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for FieldContext

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<T: 'static> From<Binding<T>> for FieldContext

Source§

fn from(binding: Binding<T>) -> Self

Converts to this type from the input type.
Source§

impl<T: 'static> From<Signal<T>> for FieldContext

Source§

fn from(signal: Signal<T>) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for FieldContext

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DependencyElement for T
where T: 'static + PartialEq + Clone,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> InitializeFromFunction<T> for T

Source§

fn initialize_from_function(f: fn() -> T) -> T

Create an instance of this type from an initialization function
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<Ret> SpawnIfAsync<(), Ret> for Ret

Source§

fn spawn(self) -> Ret

Spawn the value into the dioxus runtime if it is an async block
Source§

impl<T, O> SuperFrom<T> for O
where O: From<T>,

Source§

fn super_from(input: T) -> O

Convert from a type to another type.
Source§

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

Source§

fn super_into(self) -> O

Convert from a type to another type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more