Struct Form 

pub struct Form {
    pub kind: FormKind,
    pub span: Span,
}

A parsed Clojure form with its source location.

PartialEq ignores spans so test assertions can compare forms without constructing exact span values.

Fields

kind: FormKind

span: Span

Implementations

impl Form

pub fn new(kind: FormKind, span: Span) -> Self

pub fn heap_size(&self) -> usize

Total heap bytes owned by this form tree (excluding the Form itself).

pub fn unmeta(&self) -> &Form

The annotated form with every ^meta wrapper removed.

Returns self when the form carries no metadata. Stacked metadata (^:a ^:b x) is peeled down to the innermost form.

pub fn peel_meta(&self) -> (Vec<&Form>, &Form)

The ^meta forms attached to this form, outermost first, together with the annotated form itself.

pub fn as_symbol(&self) -> Option<&str>

The symbol name, if this form is a symbol.

pub fn as_keyword(&self) -> Option<&str>

The keyword name (without the leading :), if this form is a keyword.

pub fn as_string(&self) -> Option<&str>

The string contents, if this form is a string literal.

pub fn as_list(&self) -> Option<&[Form]>

The elements, if this form is a list.

pub fn as_vector(&self) -> Option<&[Form]>

The elements, if this form is a vector.

pub fn as_map(&self) -> Option<&[Form]>

The flat key/value pairs, if this form is a map literal.

Trait Implementations

impl Clone for Form

fn clone(&self) -> Form

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Form

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

Formats the value using the given formatter.

impl PartialEq for Form

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

Equality operator ==.

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

Inequality operator !=.