scodec-core
2.2.1
API
Generated with
scodec-core/scodec/SizeBound

SizeBound

scodec.SizeBound
See theSizeBound companion object
case class SizeBound(lowerBound: Long, upperBound: Option[Long])

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.

Attributes

lowerBound

Minimum number of bits

upperBound

Maximum number of bits

Companion:
object
Source:
SizeBound.scala
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

def *(n: Long): SizeBound

Multiplies this size bound by the specified scalar.

Multiplies this size bound by the specified scalar.

Attributes

Source:
SizeBound.scala
def +(that: SizeBound): SizeBound

Adds the specified size bound to this size bound.

Adds the specified size bound to this size bound.

Attributes

Source:
SizeBound.scala
def atLeast: SizeBound

Returns a new bound with the upper bound removed.

Returns a new bound with the upper bound removed.

Attributes

Source:
SizeBound.scala
def atMost: SizeBound

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

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

Attributes

Source:
SizeBound.scala
def exact: Option[Long]

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

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

Attributes

Source:
SizeBound.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:
SizeBound.scala
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.

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

Attributes

Source:
SizeBound.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with