Package akka.stream

Class IOResult

  • All Implemented Interfaces:
    java.io.Serializable, scala.Equals, scala.Product, scala.Serializable

    public final class IOResult
    extends java.lang.Object
    implements scala.Product, scala.Serializable
    Holds a result of an IO operation.

    param: count Numeric value depending on context, for example IO operations performed or bytes processed. param: status Status of the result. Can be either Done or an exception.

    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      IOResult​(long count, scala.util.Try<Done> status)  
    • Constructor Detail

      • IOResult

        public IOResult​(long count,
                        scala.util.Try<Done> status)
    • Method Detail

      • createSuccessful

        public static IOResult createSuccessful​(long count)
        JAVA API: Creates successful IOResult
      • createFailed

        public static IOResult createFailed​(long count,
                                            java.lang.Throwable ex)
        JAVA API: Creates failed IOResult, `count` should be the number of bytes (or other unit, please document in your APIs) processed before failing
      • apply

        public static IOResult apply​(long count,
                                     scala.util.Try<Done> status)
      • unapply

        public static scala.Option<scala.Tuple2<java.lang.Object,​scala.util.Try<Done>>> unapply​(IOResult x$0)
      • count

        public long count()
      • status

        public scala.util.Try<Done> status()
      • withCount

        public IOResult withCount​(long value)
      • withStatus

        public IOResult withStatus​(scala.util.Try<Done> value)
      • getCount

        public long getCount()
        Java API: Numeric value depending on context, for example IO operations performed or bytes processed.
        Returns:
        (undocumented)
      • wasSuccessful

        public boolean wasSuccessful()
        Java API: Indicates whether IO operation completed successfully or not.
        Returns:
        (undocumented)
      • getError

        public java.lang.Throwable getError()
        Java API: If the IO operation resulted in an error, returns the corresponding Throwable or throws UnsupportedOperationException otherwise.
        Returns:
        (undocumented)
      • copy

        public IOResult copy​(long count,
                             scala.util.Try<Done> status)
      • copy$default$1

        public long copy$default$1()
      • copy$default$2

        public scala.util.Try<Done> copy$default$2()
      • productPrefix

        public java.lang.String productPrefix()
        Specified by:
        productPrefix in interface scala.Product
      • productArity

        public int productArity()
        Specified by:
        productArity in interface scala.Product
      • productElement

        public java.lang.Object productElement​(int x$1)
        Specified by:
        productElement in interface scala.Product
      • productIterator

        public scala.collection.Iterator<java.lang.Object> productIterator()
        Specified by:
        productIterator in interface scala.Product
      • canEqual

        public boolean canEqual​(java.lang.Object x$1)
        Specified by:
        canEqual in interface scala.Equals
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object x$1)
        Specified by:
        equals in interface scala.Equals
        Overrides:
        equals in class java.lang.Object