Struct GType 

pub struct GType<T, V = NoValidation> { /* private fields */ }

A validated value.

GType<T, V> wraps a value of type T and guarantees that it satisfied validator V at construction time.

Validation is performed by GType::try_new. Once constructed, the contained value cannot be modified directly, preserving the validator’s invariants.

Examples

use g_type::GType;

let value = GType::<u32>::try_new(42).unwrap();

assert_eq!(*value.as_ref(), 42);

With a custom validator:

use core::convert::Infallible;
use g_type::{GType, Validator};

struct Percent;

impl Validator<u8> for Percent {
    type Target = u8;
    type Error = Infallible;

    fn max() -> Option<&'static Self::Target> {
        Some(&100)
    }
}

assert!(GType::<u8, Percent>::try_new(50).is_ok());
assert!(GType::<u8, Percent>::try_new(150).is_err());

Implementations

impl<T: PartialOrd<V::Target>, V: Validator<T>> GType<T, V>

pub fn try_new(value: T) -> Result<Self, GTypeError<V::Error>>

Attempts to create a validated value.

Returns an error if the value violates the validator’s minimum bound, maximum bound, or custom validation rules.

pub const fn as_ref(&self) -> &T

Returns a shared reference to the underlying value.

pub fn into_inner(self) -> T

Consumes the wrapper and returns the underlying value.

pub fn inspect<F>(self, func: F) -> Self

where F: FnOnce(&T),

Calls a function with a reference to the contained value.

Returns self unchanged.

This is primarily useful for debugging and logging in method chains.

pub fn map<U, UV, F>( self, func: F, ) -> Result<GType<U, UV>, GTypeError<UV::Error>>

where U: PartialOrd<UV::Target>, UV: Validator<U>, F: FnOnce(T) -> U,

Transforms the contained value into another validated type.

The transformed value is validated using the destination validator before being returned.

This behaves similarly to Option::map and Result::map.

pub fn and_then<U, UV, F>( self, func: F, ) -> Result<GType<U, UV>, GTypeError<UV::Error>>

where U: PartialOrd<UV::Target>, UV: Validator<U>, F: FnOnce(T) -> Result<GType<U, UV>, GTypeError<UV::Error>>,

Chains another fallible validated transformation.

This behaves similarly to Option::and_then and Result::and_then.

Trait Implementations

impl<T, V> AsRef<T> for GType<T, V>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T, V> Borrow<T> for GType<T, V>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T, V> Clone for GType<T, V>

where T: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, V> Copy for GType<T, V>

where T: Copy,

impl<T, V> Debug for GType<T, V>

where T: Debug,

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

Formats the value using the given formatter.

impl<'de, T, V> Deserialize<'de> for GType<T, V>

where T: PartialOrd<V::Target> + Deserialize<'de>, V: Validator<T>, V::Target: PartialOrd<T> + Debug, V::Error: Display,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, V> Display for GType<T, V>

where T: Display,

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

Formats the value using the given formatter.

impl<T, V> Eq for GType<T, V>

where T: Eq,

impl<T, V> Hash for GType<T, V>

where T: Hash,

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, V> Ord for GType<T, V>

where T: Ord,

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T, U, LHSV, RHSV> PartialEq<GType<U, RHSV>> for GType<T, LHSV>

where T: PartialEq<U>, U: PartialEq<T>,

fn eq(&self, other: &GType<U, RHSV>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, U, LHSV, RHSV> PartialOrd<GType<U, RHSV>> for GType<T, LHSV>

where T: PartialOrd<U>, U: PartialOrd<T>,

fn partial_cmp(&self, other: &GType<U, RHSV>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T, V> Serialize for GType<T, V>

where T: Serialize,

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

where S: Serializer,

Serialize this value into the given Serde serializer.