Struct ValueType 

pub struct ValueType {
    pub ty: RegistryType,
    pub persistence: ValueTypePersistence,
    pub evictability: Evictability,
    /* private fields */
}

A definition of a type of data.

Contains a list of traits and trait methods that are available on that type.

Fields

ty: RegistryType

persistence: ValueTypePersistence

How cells of this type participate in the persistent cache.

evictability: Evictability

Whether cells of this type can be dropped from in-memory storage on the eviction sweep. Independent of ValueType::persistence.

Implementations

impl ValueType

pub const fn new<T: VcValueType>( global_name: &'static str, persistence: ValueTypePersistence, evictability: Evictability, ) -> Self

Construct a ValueType for a non-codec persistence mode (ValueTypePersistence::Skip / ValueTypePersistence::HashOnly).

Used by #[turbo_tasks::value] for serialization = "skip" and serialization = "hash". For serialization = "auto" | "custom" use ValueType::persistable instead — its codec functions inline at the call site.

pub const fn persistable<T: VcValueType + Encode + Decode<()>>( global_name: &'static str, evictability: Evictability, ) -> Self

Construct a ValueType whose cells round-trip through the persistent cache via the auto-derived bincode Encode / Decode impls.

This is internally used by #[turbo_tasks::value] for serialization = "auto" and serialization = "custom".

pub const fn new_with_bincode_wrappers<T: VcValueType, E: ManualEncodeWrapper<Value = T>, D: ManualDecodeWrapper<Value = T>>( global_name: &'static str, evictability: Evictability, ) -> Self

This is used internally by turbo_tasks_macros::primitive to encode/decode foreign types that cannot implement the bincode traits due to the orphan rules.

This is done by constructing wrapper types that implement the bincode traits on behalf of the wrapped type.

pub fn type_id(&self) -> TypeId

Returns the TypeId of the concrete type this ValueType represents.

pub fn get_trait_method( &self, trait_method: &'static TraitMethod, ) -> Option<&'static NativeFunction>

pub fn has_trait(&self, trait_type: &TraitTypeId) -> bool

Trait Implementations

impl Debug for ValueType

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

Formats the value using the given formatter.

impl Display for ValueType

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

Formats the value using the given formatter.

impl Hash for ValueType

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 Ord for ValueType

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 PartialEq for ValueType

fn eq(&self, other: &ValueType) -> 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 PartialOrd for ValueType

fn partial_cmp(&self, other: &Self) -> 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 Collect for &'static ValueType

impl Eq for ValueType