scala.util.parsing.combinator.Parsers

Success

case class Success [+T] (result: T, next: Input) extends ParseResult[T] with Product with Serializable

The success case of ParseResult: contains the result and the remaining input.

result

The parser's output

next

The parser's remaining input

Source
Parsers.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, ParseResult[T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Success
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ParseResult
  7. AnyRef
  8. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Success (result: T, next: Input)

    result

    The parser's output

    next

    The parser's remaining input

Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  2. def != (arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Attributes
    final
    Definition Classes
    Any

  3. def ## (): Int

    Equivalent to x.hashCode except for boxed numeric types.

    Equivalent to x.hashCode except for boxed numeric types. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them.

    returns

    a hash value consistent with ==

    Attributes
    final
    Definition Classes
    AnyRef → Any

  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef

  5. def == (arg0: Any): Boolean

    Test two objects for equality.

    Test two objects for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Attributes
    final
    Definition Classes
    Any

  6. def append [U >: T] (a: ⇒ ParseResult[U]): ParseResult[U]

    Definition Classes
    Success → ParseResult

  7. def asInstanceOf [T0] : T0

    Cast the receiver object to be of type T0.

    Cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

    the receiver object.

    Attributes
    final
    Definition Classes
    Any

  8. def canEqual (arg0: Any): Boolean

    A method that should be called from every well-designed equals method that is open to be overridden in a subclass.

    A method that should be called from every well-designed equals method that is open to be overridden in a subclass. See Programming in Scala, Chapter 28 for discussion and design.

    returns

    true if this instance can possibly equal that, otherwise false

    Definition Classes
    Success → Equals

  9. def clone (): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  10. def eq (arg0: AnyRef): Boolean

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    Attributes
    final
    Definition Classes
    AnyRef

  11. def equals (arg0: Any): Boolean

    The universal equality method defined in AnyRef.

    The universal equality method defined in AnyRef.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    Success → Equals → AnyRef → Any

  12. def finalize (): Unit

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  13. def flatMapWithNext [U] (f: (T) ⇒ (Input) ⇒ ParseResult[U]): ParseResult[U]

    Definition Classes
    Success → ParseResult

  14. def get : T

    Returns the embedded result

    Returns the embedded result

    Definition Classes
    Success → ParseResult

  15. def getClass (): java.lang.Class[_ <: java.lang.Object]

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Attributes
    final
    Definition Classes
    AnyRef

  16. def getOrElse [B >: T] (default: ⇒ B): B

    Definition Classes
    ParseResult

  17. def hashCode (): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in Any.

    returns

    the hash code value for this object.

    Definition Classes
    Success → AnyRef → Any

  18. def isEmpty : Boolean

    Definition Classes
    ParseResult

  19. def isInstanceOf [T0] : Boolean

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Attributes
    final
    Definition Classes
    Any

  20. def map [U] (f: (T) ⇒ U): Success[U]

    Functional composition of ParseResults

    Functional composition of ParseResults

    returns

    f' applied to the result of this ParseResult', packaged up as a new ParseResult'

    Definition Classes
    Success → ParseResult

  21. def mapPartial [U] (f: PartialFunction[T, U], error: (T) ⇒ String): ParseResult[U]

    Partial functional composition of ParseResults

    Partial functional composition of ParseResults

    error

    a function that takes the same argument as f' and produces an error message to explain why f' wasn't applicable (it is called when this is the case)

    returns

    if `f' f is defined at the result in this `ParseResult', f' applied to the result of this ParseResult', packaged up as a new ParseResult'. If f' is not defined, Failure'.

    Definition Classes
    Success → ParseResult

  22. def ne (arg0: AnyRef): Boolean

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

    true if the argument is not a reference to the receiver object; false otherwise.

    Attributes
    final
    Definition Classes
    AnyRef

  23. val next : Input

    The parser's remaining input

    The parser's remaining input

    Definition Classes
    Success → ParseResult

  24. def notify (): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Attributes
    final
    Definition Classes
    AnyRef

  25. def notifyAll (): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    Attributes
    final
    Definition Classes
    AnyRef

  26. def productArity : Int

    The size of this product.

    The size of this product.

    returns

    for a product A(x_1, ..., x_k), returns k

    Definition Classes
    Success → Product

  27. def productElement (arg0: Int): Any

    The nth element of this product, 0-based.

    The nth element of this product, 0-based. In other words, for a product A(x_1, ..., x_k), returns x_(n+1) where 0 < n < k.

    returns

    the element n elements after the first element

    Definition Classes
    Success → Product

  28. def productIterator : Iterator[Any]

    An iterator over all the elements of this product.

    An iterator over all the elements of this product.

    returns

    in the default implementation, an Iterator[Any]

    Definition Classes
    Product

  29. def productPrefix : String

    A string used in the toString methods of derived classes.

    A string used in the toString methods of derived classes. Implementations may override this method to prepend a string prefix to the result of toString methods.

    returns

    in the default implementation, the empty string

    Definition Classes
    Success → Product

  30. val result : T

    The parser's output

  31. val successful : Boolean

    Definition Classes
    Success → ParseResult

  32. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef

  33. def toString (): String

    The toString method of a Success

    The toString method of a Success

    returns

    a String representation of the object.

    Definition Classes
    Success → AnyRef → Any

  34. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  35. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  36. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

  37. def productElements : Iterator[Any]

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    use productIterator instead