parsley
4.3.0-RC2
API
Generated with
parsley/parsley/Failure

Failure

parsley.Failure
See theFailure companion object
class Failure[Err] extends Result[Err, Nothing], Product, Serializable

This class is used for a parser failure, and contains the error message.

Type parameters

Err

the type of the error message generated by the failing parse.

Value parameters

_msg

the error message reported by the parser (passed lazily).

Attributes

Companion
object
Source
Result.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Result[Err, Nothing]
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def canEqual(x: Any): Boolean

Attributes

Definition Classes
Source
Result.scala
def copy(msg: => Err): Failure[Err]

Attributes

Source
Result.scala
override def equals(x: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

- It is reflexive: for any instance x of type Any, x.equals(x) should return true. - It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. - It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

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

Definition Classes
Equals -> Any
Source
Result.scala
override def get: Nothing

Returns the successful value within the result.

Returns the successful value within the result.

This is equivalent to:

result match {
 case Success(x) => x
 case _          => throw new Exception
}

Attributes

Definition Classes
Source
Result.scala
override def hashCode: Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
Source
Result.scala
override def isFailure: Boolean

Returns true if this is a Failure, false otherwise.

Returns true if this is a Failure, false otherwise.

Attributes

Definition Classes
Source
Result.scala
override def isSuccess: Boolean

Returns true if this is a Success, false otherwise.

Returns true if this is a Success, false otherwise.

Attributes

Definition Classes
Source
Result.scala
override def productArity: Int

Attributes

Definition Classes
Source
Result.scala
override def productElement(idx: Int): Any

Attributes

Definition Classes
Source
Result.scala
override def productPrefix: String

Attributes

Definition Classes
Source
Result.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
Source
Result.scala

Inherited methods

def contains[B](elem: B): Boolean

Returns true if this result is a Success and its value is equal to elem (as determined by ==), returns false otherwise.

Returns true if this result is a Success and its value is equal to elem (as determined by ==), returns false otherwise.

Value parameters

elem

the element to test.

Attributes

Returns

true if this is a Success value equal to elem.

Since

1.7.0

Inherited from:
Result
Source
Result.scala
def exists(p: Nothing => Boolean): Boolean

Returns false if Failure or returns the result of the application of the given predicate to the Success value.

Returns false if Failure or returns the result of the application of the given predicate to the Success value.

Attributes

Since

1.7.0

Inherited from:
Result
Source
Result.scala
def filterOrElse[Errʹ >: Err](p: Nothing => Boolean, msg: => Errʹ): Result[Errʹ, A]

Returns Success with the existing value of Success if this is a Success and the given predicate p holds for the right value, or Failure(msg) if this is a Success and the given predicate p does not hold for the right value, or Failure with the existing value of Failure if this is a Failure.

Returns Success with the existing value of Success if this is a Success and the given predicate p holds for the right value, or Failure(msg) if this is a Success and the given predicate p does not hold for the right value, or Failure with the existing value of Failure if this is a Failure.

Attributes

Since

1.7.0

Inherited from:
Result
Source
Result.scala
def flatMap[B, Errʹ >: Err](f: Nothing => Result[Errʹ, B]): Result[Errʹ, B]

Returns the result of applying f to this result if it is a success.

Returns the result of applying f to this result if it is a success. Returns a failure if this result is a failure. Differs from map as f returns a result instead of just a value.

Attributes

Since

1.7.0

Inherited from:
Result
Source
Result.scala
def flatten[B, Errʹ >: Err](implicit ev: Nothing <:< Result[Errʹ, B]): Result[Errʹ, B]

Returns the nested result if this result is a success, otherwise return this failure.

Returns the nested result if this result is a success, otherwise return this failure.

Equivalent to flatMap(identity[Result[Errʹ, B]]).

Attributes

Since

1.7.0

Inherited from:
Result
Source
Result.scala
def fold[B](ferr: Err => B, fa: Nothing => B): B

Returns the result of applying ferr to this result's error if this is a Failure or fa to the result stored in the Success otherwise.

Returns the result of applying ferr to this result's error if this is a Failure or fa to the result stored in the Success otherwise.

Value parameters

fa

the function to apply if this is a Success.

ferr

the function to apply if this is a Failure.

Attributes

Returns

the results of applying the function

Since

1.7.0

Inherited from:
Result
Source
Result.scala
def forall(f: Nothing => Boolean): Boolean

Returns true if this result is a Failure or returns the result of the application of the given predicate to the Success value.

Returns true if this result is a Failure or returns the result of the application of the given predicate to the Success value.

Attributes

Since

1.7.0

Inherited from:
Result
Source
Result.scala
def foreach[U](f: Nothing => U): Unit

Executes the procedure f if this is a Success.

Executes the procedure f if this is a Success. Otherwise, do nothing.

This is equivalent to:

result match {
 case Success(x) => f(x)
 case _          => ()
}

Value parameters

f

The side-effecting function to execute.

Attributes

Since

1.7.0

Inherited from:
Result
Source
Result.scala
def getOrElse[B](default: => B): B

Returns the value from this Success or the result of evaluating default if this is a Failure.

Returns the value from this Success or the result of evaluating default if this is a Failure.

Attributes

Since

1.7.0

Inherited from:
Result
Source
Result.scala
def map[B](f: Nothing => B): Result[Err, B]

Returns a Success containing the result of applying f to this result's value if this is a success.

Returns a Success containing the result of applying f to this result's value if this is a success. Otherwise, returns a failure.

Attributes

Since

1.7.0

Inherited from:
Result
Source
Result.scala
def orElse[B, Errʹ >: Err](alternative: => Result[Errʹ, B]): Result[Errʹ, B]

Returns this result if it is a Success, otherwise return the result of evaluating alternative.

Returns this result if it is a Success, otherwise return the result of evaluating alternative.

Attributes

Since

1.7.0

Inherited from:
Result
Source
Result.scala
def productElementName(n: Int): String

Attributes

Inherited from:
Product
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def toEither: Either[Err, A]

Converts the Result into a Either where Failure maps to a Left[Err].

Converts the Result into a Either where Failure maps to a Left[Err].

Attributes

Since

1.7.0

Inherited from:
Result
Source
Result.scala
def toOption: Option[A]

Returns a Some containing the Success value if it exists or a None if this is a Failure.

Returns a Some containing the Success value if it exists or a None if this is a Failure.

Attributes

Since

1.7.0

Inherited from:
Result
Source
Result.scala
def toSeq: Seq[A]

Returns a Seq containing the Success value if it exists or an empty Seq if this is a Failure.

Returns a Seq containing the Success value if it exists or an empty Seq if this is a Failure.

Attributes

Since

1.7.0

Inherited from:
Result
Source
Result.scala
def toTry: Try[A]

Converts the Result into a Try where Failure maps to a plain Exception.

Converts the Result into a Try where Failure maps to a plain Exception.

Attributes

Since

1.7.0

Inherited from:
Result
Source
Result.scala

Concrete fields

lazy val msg: Err

Attributes

Source
Result.scala
Generated with