com.scalacraft.domain.v2.binary

Octet

Related Docs: object Octet | package binary

case class Octet extends Product with Serializable

An Octet represents an integer in the range [0, 255].

The following constraints hold for instances of this class,

- octet is in the range [0, 255]

An instance can be created using a suitable overload of the opt method.

val octetOpt1: Option[Octet] = Octet.opt(117)
val octetOpt2: Option[Octet] = Octet.opt(0x75)
val octetOpt3: Option[Octet] = Octet.opt("fe") // Decimal 254
val octetOpt4: Option[Octet] = Octet.opt("d") // Decimal 13
val octetOpt5: Option[Octet] = Octet.opt("12") // Decimal 18

Note that the string variant takes either one or two hex characters.

When any class constraint is violated the result is None.

val octetOpt: Option[Octet] = Octet.opt("NaN") // None
Pattern Matching

Pattern matching is supported as the following examples demonstrate,

7 match {
  case Octet(n) => n // 7
  case _ => None
}

The match target can be a string,

val s: String = "20"

s match {
  case Octet(n) => n  // 32
  case _ => None
}

Invalid octets are not matched,

-129 match {
  case Octet(n) => n
  case _ => None // None
}
Implicit Conversions

Implicit conversions exists which allow an instance of Octet to be used when an Int or String is required.

val Some(hi) = Octet.opt(4)
val Some(lo) = Octet.opt(3)
val w: Int = 256 * hi + lo // 0x0403

A conversion to the unconstrained version of this class is also available.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Octet
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

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

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  5. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  7. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  9. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  11. final def notify(): Unit

    Definition Classes
    AnyRef

  12. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  13. val octet: Int

    A valid octet

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

    Definition Classes
    AnyRef

  15. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped