trait HasVersionedWrapper[ValueClass] extends HasVersionedToByteString
Trait for classes that can be serialized by using ProtoBuf. See "CONTRIBUTING.md" for our guidelines on serialization.
This wrapper is to be used if a single instance needs to be serialized to different proto versions.
The underlying ProtoClass is com.digitalasset.canton.version.UntypedVersionedMessage but we often specify the typed alias com.digitalasset.canton.version.VersionedMessage instead.
- Self Type
- HasVersionedWrapper[ValueClass] with ValueClass
- Alphabetic
- By Inheritance
- HasVersionedWrapper
- HasVersionedToByteString
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def companionObj: HasVersionedMessageCompanionCommon[ValueClass]
- Attributes
- protected
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toByteArray(version: ProtocolVersion): Array[Byte]
Yields a byte array representation of the corresponding
UntypedVersionedMessagewrapper of this instance. - def toByteString(version: ProtocolVersion): ByteString
Yields a byte string representation of the corresponding
UntypedVersionedMessagewrapper of this instance.Yields a byte string representation of the corresponding
UntypedVersionedMessagewrapper of this instance.- Definition Classes
- HasVersionedWrapper → HasVersionedToByteString
- def toProtoVersioned(version: ProtocolVersion): VersionedMessage[ValueClass]
Yields the proto representation of the class inside an
UntypedVersionedMessagewrapper.Yields the proto representation of the class inside an
UntypedVersionedMessagewrapper.Subclasses should make this method public by default, as this supports composing proto serializations. Keep it protected, if there are good reasons for it (e.g. com.digitalasset.canton.serialization.ProtocolVersionedMemoizedEvidence).
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def writeToFile(outputFile: String, version: ProtocolVersion = ProtocolVersion.latest): Unit
Writes the byte string representation of the corresponding
UntypedVersionedMessagewrapper of this instance to a file.