chisel
7.12.0+36-5ebc476b-SNAPSHOT
API
Generated with
chisel/chisel3/chisel3.simulator/Peekable

Peekable

chisel3.simulator.Peekable
trait Peekable[T <: Data]

Attributes

Source
PeekPokeAPI.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait PeekPokable[T]
class TestableData[T]
class TestableRecord[T]
class TestableVec[T]
trait TestableElement[T]
class TestableBool
class TestableEnum[T]
class TestableSInt
class TestableUInt
Show all

Members list

Value members

Abstract methods

def expect(expected: T, message: String)(implicit sourceInfo: SourceInfo): Unit

Expect the value of a data port to be equal to the expected value.

Expect the value of a data port to be equal to the expected value.

Value parameters

expected

the expected value

message

a message for the failure case

Attributes

Throws
FailedExpectationException

if the observed value does not match the expected value

Source
PeekPokeAPI.scala
def peek()(implicit sourceInfo: SourceInfo): T

Get the value of a data port as a literal.

Get the value of a data port as a literal.

Attributes

Returns

the value of the peeked data

Source
PeekPokeAPI.scala

Concrete methods

def expect(expected: T)(implicit sourceInfo: SourceInfo): Unit

Expect the value of a data port to be equal to the expected value.

Expect the value of a data port to be equal to the expected value.

Value parameters

expected

the expected value

Attributes

Throws
FailedExpectationException

if the observed value does not match the expected value

Source
PeekPokeAPI.scala
def expect(expected: T, format: Type)(implicit sourceInfo: SourceInfo): Unit

Expect the value of a data port to be equal to the expected value.

Expect the value of a data port to be equal to the expected value.

Value parameters

expected

the expected value

format

formatting strategy for rendered values in failure output

Attributes

Throws
FailedExpectationException

if the observed value does not match the expected value

Source
PeekPokeAPI.scala
def expect(expected: T, message: String, format: Type)(implicit sourceInfo: SourceInfo): Unit

Expect the value of a data port to be equal to the expected value.

Expect the value of a data port to be equal to the expected value.

Value parameters

expected

the expected value

format

formatting strategy for rendered values in failure output

message

a message for the failure case

Attributes

Throws
FailedExpectationException

if the observed value does not match the expected value

Source
PeekPokeAPI.scala
Generated with