Class/Object

scodec

SizeBound

Related Docs: object SizeBound | package scodec

Permalink

final case class SizeBound(lowerBound: Long, upperBound: Option[Long]) extends Product with Serializable

Bounds the size, in bits, of the binary encoding of a codec -- i.e., it provides a lower bound and an upper bound on the size of bit vectors returned as a result of encoding.

lowerBound

Minimum number of bits

upperBound

Maximum number of bits

Source
SizeBound.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SizeBound
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SizeBound(lowerBound: Long, upperBound: Option[Long])

    Permalink

    lowerBound

    Minimum number of bits

    upperBound

    Maximum number of bits

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def *(n: Long): SizeBound

    Permalink

    Multiplies this size bound by the specified scalar.

  4. def +(that: SizeBound): SizeBound

    Permalink

    Adds the specified size bound to this size bound.

  5. def ->[B](y: B): (SizeBound, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SizeBound to ArrowAssoc[SizeBound] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  6. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  8. def atLeast: SizeBound

    Permalink

    Returns a new bound with the upper bound removed.

  9. def atMost: SizeBound

    Permalink

    Returns a new bound with the lower bound reset to 0.

  10. def clone(): AnyRef

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

  11. def ensuring(cond: (SizeBound) ⇒ Boolean, msg: ⇒ Any): SizeBound

    Permalink
    Implicit information
    This member is added by an implicit conversion from SizeBound to Ensuring[SizeBound] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: (SizeBound) ⇒ Boolean): SizeBound

    Permalink
    Implicit information
    This member is added by an implicit conversion from SizeBound to Ensuring[SizeBound] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean, msg: ⇒ Any): SizeBound

    Permalink
    Implicit information
    This member is added by an implicit conversion from SizeBound to Ensuring[SizeBound] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: Boolean): SizeBound

    Permalink
    Implicit information
    This member is added by an implicit conversion from SizeBound to Ensuring[SizeBound] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  16. def exact: Option[Long]

    Permalink

    Returns the exact size of the encoded bits.

    Returns the exact size of the encoded bits. Defined when the lower bound is equal to the upper bound.

  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  18. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SizeBound to StringFormat[SizeBound] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  21. val lowerBound: Long

    Permalink

    Minimum number of bits

  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  26. def toString(): String

    Permalink
    Definition Classes
    SizeBound → AnyRef → Any

  27. val upperBound: Option[Long]

    Permalink

    Maximum number of bits

  28. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. def |(that: SizeBound): SizeBound

    Permalink

    ORs the specified size bound with this size bound, resulting in a new bound which has the minimum lower bound and maximum upper bound.

  32. def →[B](y: B): (SizeBound, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SizeBound to ArrowAssoc[SizeBound] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SizeBound to any2stringadd[SizeBound] performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (sizeBound: any2stringadd[SizeBound]).+(other)
    Definition Classes
    any2stringadd

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from SizeBound to any2stringadd[SizeBound]

Inherited by implicit conversion StringFormat from SizeBound to StringFormat[SizeBound]

Inherited by implicit conversion Ensuring from SizeBound to Ensuring[SizeBound]

Inherited by implicit conversion ArrowAssoc from SizeBound to ArrowAssoc[SizeBound]

Ungrouped