Struct hyperbole::field::Field

pub struct Field<T, const NAME: &'static str> { /* fields omitted */ }

A named value where the name is lifted to the type level, analagous to a struct field.

This struct is intended to be named and instantiated via the f! or record! macros.

Implementations

impl<T, const NAME: &'static str> Field<T, NAME>

pub const fn new(inner: T) -> Self

Returns a new field.

pub fn into_inner(self) -> T

Extracts the field's inner value.

pub const NAME: &'static str

The field's name.

Trait Implementations

impl<T: Clone, const NAME: &'static str> Clone for Field<T, NAME>

fn clone(&self) -> Field<T, NAME>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy, const NAME: &'static str> Copy for Field<T, NAME>

impl<T: Debug, const NAME: &'static str> Debug for Field<T, NAME>

fn fmt(&self, w: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T, const NAME: &'static str> Deref for Field<T, NAME>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, const NAME: &'static str> DerefMut for Field<T, NAME>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, T: Deserialize<'de>, const NAME: &'static str> Deserialize<'de> for Field<T, NAME>

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<T: Display, const NAME: &'static str> Display for Field<T, NAME>

fn fmt(&self, w: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Eq, const NAME: &'static str> Eq for Field<T, NAME>

impl<T, const NAME: &'static str> From<T> for Field<T, NAME>

fn from(inner: T) -> Self

Performs the conversion.

impl<T: FromStr, const NAME: &'static str> FromStr for Field<T, NAME>

type Err = T::Err

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<T: Hash, const NAME: &'static str> Hash for Field<T, NAME>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<T: Ord, const NAME: &'static str> Ord for Field<T, NAME>

fn cmp(&self, other: &Field<T, NAME>) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: PartialEq, const NAME: &'static str> PartialEq<Field<T, NAME>> for Field<T, NAME>

fn eq(&self, other: &Field<T, NAME>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Field<T, NAME>) -> bool

This method tests for !=.

impl<T: PartialOrd, const NAME: &'static str> PartialOrd<Field<T, NAME>> for Field<T, NAME>

fn partial_cmp(&self, other: &Field<T, NAME>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Field<T, NAME>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Field<T, NAME>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Field<T, NAME>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Field<T, NAME>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Reply, const NAME: &'static str> Reply for Field<T, NAME>

fn into_response(self) -> Response

Perform the conversion.

fn with_status(self, code: StatusCode) -> Response

Change the status code to code.

fn with_header<H: Header>(self, header: H) -> Response

Include a typed header in the response.

impl<T: Serialize, const NAME: &'static str> Serialize for Field<T, NAME>

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<T, const NAME: &'static str> StructuralEq for Field<T, NAME>

impl<T, const NAME: &'static str> StructuralPartialEq for Field<T, NAME>