Enum Type 

pub enum Type<N: TreeNode = SyntaxNode> {
    Map(MapType<N>),
    Array(ArrayType<N>),
    Pair(PairType<N>),
    Object(ObjectType<N>),
    Ref(TypeRef<N>),
    Primitive(PrimitiveType<N>),
}

Represents a type.

Variants

Map(MapType<N>)

The type is a map.

Array(ArrayType<N>)

The type is an array.

Pair(PairType<N>)

The type is a pair.

Object(ObjectType<N>)

The type is an object.

Ref(TypeRef<N>)

The type is a reference to custom type.

Primitive(PrimitiveType<N>)

The type is a primitive.

Implementations

impl<N: TreeNode> Type<N>

pub fn can_cast(kind: SyntaxKind) -> bool

Type.

pub fn cast(inner: N) -> Option<Self>

Casts the given node to Type.

Returns None if the node cannot be cast.

pub fn inner(&self) -> &N

Gets a reference to the inner node.

pub fn is_optional(&self) -> bool

Determines if the type is optional.

pub fn as_map_type(&self) -> Option<&MapType<N>>

Attempts to get a reference to the inner MapType.

• If self is a Type::Map, then a reference to the inner MapType is returned wrapped in Some.
• Else, None is returned.

pub fn into_map_type(self) -> Option<MapType<N>>

Consumes self and attempts to return the inner MapType.

• If self is a Type::Map, then the inner MapType is returned wrapped in Some.
• Else, None is returned.

pub fn unwrap_map_type(self) -> MapType<N>

Unwraps the type into a map type.

Panics

Panics if the type is not a map type.

pub fn as_array_type(&self) -> Option<&ArrayType<N>>

Attempts to get a reference to the inner ArrayType.

• If self is a Type::Array, then a reference to the inner ArrayType is returned wrapped in Some.
• Else, None is returned.

pub fn into_array_type(self) -> Option<ArrayType<N>>

Consumes self and attempts to return the inner ArrayType.

• If self is a Type::Array, then the inner ArrayType is returned wrapped in Some.
• Else, None is returned.

pub fn unwrap_array_type(self) -> ArrayType<N>

Unwraps the type into an array type.

Panics

Panics if the type is not an array type.

pub fn as_pair_type(&self) -> Option<&PairType<N>>

Attempts to get a reference to the inner PairType.

• If self is a Type::Pair, then a reference to the inner PairType is returned wrapped in Some.
• Else, None is returned.

pub fn into_pair_type(self) -> Option<PairType<N>>

Consumes self and attempts to return the inner PairType.

• If self is a Type::Pair, then the inner PairType is returned wrapped in Some.
• Else, None is returned.

pub fn unwrap_pair_type(self) -> PairType<N>

Unwraps the type into a pair type.

Panics

Panics if the type is not a pair type.

pub fn as_object_type(&self) -> Option<&ObjectType<N>>

Attempts to get a reference to the inner ObjectType.

• If self is a Type::Object, then a reference to the inner ObjectType is returned wrapped in Some.
• Else, None is returned.

pub fn into_object_type(self) -> Option<ObjectType<N>>

Consumes self and attempts to return the inner ObjectType.

• If self is a Type::Object, then the inner ObjectType is returned wrapped in Some.
• Else, None is returned.

pub fn unwrap_object_type(self) -> ObjectType<N>

Unwraps the type into an object type.

Panics

Panics if the type is not an object type.

pub fn as_type_ref(&self) -> Option<&TypeRef<N>>

Attempts to get a reference to the inner TypeRef.

• If self is a Type::Ref, then a reference to the inner TypeRef is returned wrapped in Some.
• Else, None is returned.

pub fn into_type_ref(self) -> Option<TypeRef<N>>

Consumes self and attempts to return the inner TypeRef.

• If self is a Type::Ref, then the inner TypeRef is returned wrapped in Some.
• Else, None is returned.

pub fn unwrap_type_ref(self) -> TypeRef<N>

Unwraps the type into a type reference.

Panics

Panics if the type is not a type reference.

pub fn as_primitive_type(&self) -> Option<&PrimitiveType<N>>

Attempts to get a reference to the inner PrimitiveType.

• If self is a Type::Primitive, then a reference to the inner PrimitiveType is returned wrapped in Some.
• Else, None is returned.

pub fn into_primitive_type(self) -> Option<PrimitiveType<N>>

Consumes self and attempts to return the inner PrimitiveType.

• If self is a Type::Primitive, then the inner PrimitiveType is returned wrapped in Some.
• Else, None is returned.

pub fn unwrap_primitive_type(self) -> PrimitiveType<N>

Unwraps the type into a primitive type.

Panics

Panics if the type is not a primitive type.

pub fn child(node: &N) -> Option<Self>

Finds the first child that can be cast to a Type.

pub fn children(node: &N) -> impl Iterator<Item = Self> + use<'_, N>

Finds all children that can be cast to a Type.

Trait Implementations

impl<N: Clone + TreeNode> Clone for Type<N>

fn clone(&self) -> Type<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N: Debug + TreeNode> Debug for Type<N>

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

Formats the value using the given formatter.

impl Display for Type

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

Formats the value using the given formatter.

impl<N: TreeNode> PartialEq for Type<N>

fn eq(&self, other: &Self) -> 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<N: Eq + TreeNode> Eq for Type<N>