Struct IndexSignature 

pub struct IndexSignature {
    pub string_keyof_includes_number: bool,
    pub key: Box<Type>,
    pub value: Box<Type>,
    pub readonly: bool,
}

Values available under arbitrary string property names.

Fields

string_keyof_includes_number: bool

key: Box<Type>

value: Box<Type>

readonly: bool

Implementations

impl IndexSignature

pub fn map_types(&self, transform: impl FnMut(&Type) -> Type) -> Self

pub fn try_map_types<E>( &self, transform: impl FnMut(&Type) -> Result<Type, E>, ) -> Result<Self, E>

map_types with a transform that can fail.

pub fn read_ty(&self) -> Type

The type a read through the signature gives: the value type, as in tsc’s --strict. A key the object doesn’t have is a missing value, which a check at the read or a place that holds undefined decides (see typechecker::infer::missing_reads); anywhere else it throws MissingValueError.

Trait Implementations

impl Clone for IndexSignature

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 IndexSignature

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IndexSignature

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for IndexSignature

impl Ord for IndexSignature

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 IndexSignature

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for IndexSignature

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 IndexSignature

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 IndexSignature