com.scalacraft.domain.v2.binary.unconstrained

Octet

Related Docs: object Octet | package unconstrained

case class Octet(octet: Option[Int]) extends Product with Serializable

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

This class does not constrain the value of the octet beyond requiring a non-null constructor argument.

The value maybe outside the given range or undefined.

Pattern Matching

Pattern matching is supported as the following examples demonstrate,

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

The match target can be a string,

val s: String = "ff"
s match {
  case Octet(n) => n // Some(255)
  case _ => None
}

A null or whitespace string will match to Octet(None) while a non-hex value will not match.

val s: String = " " * 4
s match {
  case Octet(n) => n  // None
  case _ => None
}
val s = "foobarbaz"
s match {
  case Octet(n) => n
  case _ => None  // None
}
Implicit Conversions

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

val octet = Octet(1022)  // The value is not constrained
val i: Option[Int] = octet  // Some(1022)

A conversion to an option of the constrained version of this class is also available.

octet

An optional octet value

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

Instance Constructors

  1. new Octet(octet: Option[Int])

    octet

    An optional octet value

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: Option[Int]

    An optional octet value

  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