Class: Parslet::Atoms::Named

### Home Classes Methods

### In Files

- lib/parslet/atoms/named.rb
- lib/parslet/atoms/visitor.rb

### Parent

Parslet::Atoms::Base

### Methods

- ::new
- #accept
- #apply
- #to_s_inner

### Files

- README

### Class/Module Index

Quicksearch

- Parslet
- Parslet::Atoms
- Parslet::Atoms::Alternative
- Parslet::Atoms::Base
- Parslet::Atoms::CanFlatten
- Parslet::Atoms::Capture
- Parslet::Atoms::Context
- Parslet::Atoms::DSL
- Parslet::Atoms::Dynamic
- Parslet::Atoms::Entity
- Parslet::Atoms::Lookahead
- Parslet::Atoms::Named
- Parslet::Atoms::Precedence
- Parslet::Atoms::Re
- Parslet::Atoms::Repetition
- Parslet::Atoms::Scope
- Parslet::Atoms::Sequence
- Parslet::Atoms::Str
- Parslet::Cause
- Parslet::ClassMethods
- Parslet::DelayedMatchConstructor
- Parslet::ErrorReporter
- Parslet::ErrorReporter::Deepest
- Parslet::ErrorReporter::Tree
- Parslet::Expression
- Parslet::Expression::Treetop
- Parslet::Expression::Treetop::Parser
- Parslet::Expression::Treetop::Transform
- Parslet::ParseFailed
- Parslet::Parser
- Parslet::Parser::PrettyPrinter
- Parslet::Parser::Visitors
- Parslet::Parser::Visitors::Citrus
- Parslet::Parser::Visitors::Treetop
- Parslet::Pattern
- Parslet::Pattern::SequenceBind
- Parslet::Pattern::SimpleBind
- Parslet::Pattern::SubtreeBind
- Parslet::Scope
- Parslet::Scope::Binding
- Parslet::Scope::NotFound
- Parslet::Slice
- Parslet::Source
- Parslet::Source::LineCache
- Parslet::Source::RangeSearch
- Parslet::Transform
- Parslet::Transform::Context

No matching classes.

# Parslet::Atoms::Named

Names a match to influence tree construction.

Example:

    str('foo')            # will return 'foo',
    str('foo').as(:foo)   # will return :foo => 'foo'

### Attributes

name[R]
parslet[R]

### Public Class Methods

new(parslet, name) click to toggle source

    # File lib/parslet/atoms/named.rb, line 10
    def initialize(parslet, name)
      super()

      @parslet, @name = parslet, name
    end

### Public Instance Methods

accept(visitor) click to toggle source

Call back visitors visit_named method. See parslet/export for an example.

    # File lib/parslet/atoms/visitor.rb, line 33
    def accept(visitor)
      visitor.visit_named(name, parslet)
    end

apply(source, context, consume_all) click to toggle source

    # File lib/parslet/atoms/named.rb, line 16
    def apply(source, context, consume_all)
      success, value = result = parslet.apply(source, context, consume_all)

      return result unless success
      succ(
        produce_return_value(
          value))
    end

to_s_inner(prec) click to toggle source

    # File lib/parslet/atoms/named.rb, line 25
    def to_s_inner(prec)
      "#{name}:#{parslet.to_s(prec)}"
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.