Struct ObjectField 

pub struct ObjectField {
    pub ty: Type,
    pub optional: bool,
    pub readonly: bool,
    pub method: bool,
}

optional: true means reads widen to ty | undefined and construction may omit the field. Distinct from a value-nullable field (ty: T | null, optional: false): must be present but can be null.

Fields

ty: Type

optional: bool

readonly: bool

readonly forbids writes through the field; assignability treats a writable target field invariantly (see assignable.rs). Inferred object literals and freshly-synthesized shapes are writable (false); only an explicit readonly modifier on an object-type/interface property sets this.

method: bool

A method rather than a function-typed property. tsc compares a method’s parameters bivariantly and a property’s contravariantly.

Implementations

impl ObjectField

pub fn required(ty: Type) -> Self

pub fn optional(ty: Type) -> Self

pub fn read_ty(&self) -> Type

The type a read of this field yields: an optional field widens to T | undefined, since an absent property reads as undefined. Every field read — object type, interface property, class field, union member, and codegen’s mirror of all four — goes through this, so the widening rule has one definition.

pub fn widen_optional(optional: bool, ty: Type) -> Type

read_ty for callers holding the two facts separately (an interface PropertySig, a class FieldSig).

Trait Implementations

impl Clone for ObjectField

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectField

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ObjectField

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ObjectField

impl Ord for ObjectField

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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for ObjectField

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ObjectField

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 Serialize for ObjectField

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ObjectField