scodec

SizeBound

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 any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

    lowerBound

    Minimum number of bits

    upperBound

    Maximum number of bits

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def *(n: Long): SizeBound

    Multiplies this size bound by the specified scalar.

  5. def +(that: SizeBound): SizeBound

    Adds the specified size bound to this size bound.

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

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

  7. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. def atLeast: SizeBound

    Returns a new bound with the upper bound removed.

  11. def atMost: SizeBound

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

  12. def clone(): AnyRef

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

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

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

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

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

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

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

  16. def ensuring(cond: Boolean): SizeBound

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

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

    Definition Classes
    AnyRef

  18. def exact: Option[Long]

    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.

  19. def finalize(): Unit

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

  20. def formatted(fmtstr: String): String

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

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

    Definition Classes
    AnyRef → Any

  22. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  23. val lowerBound: Long

    Minimum number of bits

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

    Definition Classes
    AnyRef

  25. final def notify(): Unit

    Definition Classes
    AnyRef

  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  28. def toString(): String

    Definition Classes
    SizeBound → AnyRef → Any

  29. val upperBound: Option[Long]

    Maximum number of bits

  30. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. def |(that: SizeBound): SizeBound

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

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

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

Shadowed Implicit Value Members

  1. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from SizeBound to StringAdd 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: StringAdd).+(other)
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from SizeBound to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (sizeBound: StringAdd).self
    Definition Classes
    StringAdd

  3. val self: Any

    Implicit information
    This member is added by an implicit conversion from SizeBound to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (sizeBound: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: SizeBound

    Implicit information
    This member is added by an implicit conversion from SizeBound to ArrowAssoc[SizeBound] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (sizeBound: ArrowAssoc[SizeBound]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: SizeBound

    Implicit information
    This member is added by an implicit conversion from SizeBound to Ensuring[SizeBound] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (sizeBound: Ensuring[SizeBound]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

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 StringAdd

Inherited by implicit conversion any2stringfmt from SizeBound to StringFormat

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

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

Ungrouped