t

com.digitalasset.canton.version

HasProtocolVersionedWithContextCompanion

trait HasProtocolVersionedWithContextCompanion[ValueClass <: HasRepresentativeProtocolVersion, Context] extends HasProtocolVersionedWrapperCompanion[ValueClass]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HasProtocolVersionedWithContextCompanion
  2. HasProtocolVersionedWrapperCompanion
  3. HasSupportedProtoVersions
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type DataByteString = ByteString
  2. type Deserializer = (Context, DataByteString) => ParsingResult[ValueClass]
  3. type OriginalByteString = ByteString
  4. type Serializer = (ValueClass) => ByteString
    Definition Classes
    HasSupportedProtoVersions
  5. case class LegacyProtoConverter(fromInclusive: RepresentativeProtocolVersion[ValueClass], deserializer: Deserializer, serializer: Serializer) extends ProtoCodec with Product with Serializable

    Used to (de)serialize classes which for legacy reasons where not wrapped in VersionedMessage Chances are this is NOT the class you want to use, use VersionedProtoConverter instead when adding serialization to a new class

    Used to (de)serialize classes which for legacy reasons where not wrapped in VersionedMessage Chances are this is NOT the class you want to use, use VersionedProtoConverter instead when adding serialization to a new class

    Definition Classes
    HasSupportedProtoVersions
  6. sealed trait ProtoCodec extends AnyRef

    Base class for (de)serializating from/to protobuf of ValueClass from a specific PV

    Base class for (de)serializating from/to protobuf of ValueClass from a specific PV

    Definition Classes
    HasSupportedProtoVersions
  7. case class SupportedProtoVersions extends Product with Serializable
    Definition Classes
    HasSupportedProtoVersions
  8. case class VersionedProtoConverter(fromInclusive: RepresentativeProtocolVersion[ValueClass], deserializer: Deserializer, serializer: Serializer) extends ProtoCodec with Product with Serializable

    Supported Proto version

    Supported Proto version

    fromInclusive

    The protocol version when this Proto version was introduced

    deserializer

    Deserialization method

    serializer

    Serialization method

    Definition Classes
    HasSupportedProtoVersions

Abstract Value Members

  1. abstract def name: String

    The name of the class as used for pretty-printing and error reporting

    The name of the class as used for pretty-printing and error reporting

    Attributes
    protected
    Definition Classes
    HasProtocolVersionedWrapperCompanionHasSupportedProtoVersions
  2. abstract def supportedProtoVersions: SupportedProtoVersions

    Proto versions that are supported by fromProtoVersioned and fromByteString See the helper supportedProtoVersion below to define a Parser.

    Proto versions that are supported by fromProtoVersioned and fromByteString See the helper supportedProtoVersion below to define a Parser.

    Definition Classes
    HasSupportedProtoVersions

Concrete 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. def deserializeForVersion(rpv: RepresentativeProtocolVersion[ValueClass], deserializeLegacyProto: (Deserializer) => ParsingResult[ValueClass], deserializeVersionedProto: => ParsingResult[ValueClass]): ParsingResult[ValueClass]
    Attributes
    protected
    Definition Classes
    HasProtocolVersionedWrapperCompanion
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def fromByteString(protocolVersion: ProtocolVersion)(context: Context)(bytes: OriginalByteString): ParsingResult[ValueClass]

    Use this method when deserializing bytes for classes that have a legacy proto converter to explicitly set the protocol version to use for the deserialization.

    Use this method when deserializing bytes for classes that have a legacy proto converter to explicitly set the protocol version to use for the deserialization.

    protocolVersion

    protocol version of the bytes to be deserialized

    bytes

    data

  10. def fromByteString(protoVersion: ProtoVersion)(context: Context)(bytes: OriginalByteString): ParsingResult[ValueClass]

    Use this method when deserializing bytes for classes that have a legacy proto converter to explicitly set the Proto version to use for the deserialization.

    Use this method when deserializing bytes for classes that have a legacy proto converter to explicitly set the Proto version to use for the deserialization.

    protoVersion

    Proto version of the bytes to be deserialized

    bytes

    data

  11. def fromByteString(context: Context)(bytes: OriginalByteString): ParsingResult[ValueClass]
  12. def fromProtoVersioned(context: Context)(proto: VersionedMessage[ValueClass]): ParsingResult[ValueClass]
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def protoVersionFor(protocolVersion: ProtocolVersion): ProtoVersion

    Return the Proto version corresponding to the protocol version

    Return the Proto version corresponding to the protocol version

    Definition Classes
    HasSupportedProtoVersions
  20. def protoVersionFor(protocolVersion: RepresentativeProtocolVersion[ValueClass]): ProtoVersion

    Return the Proto version corresponding to the representative protocol version

    Return the Proto version corresponding to the representative protocol version

    Definition Classes
    HasSupportedProtoVersions
  21. def protocolVersionRepresentativeFor(protoVersion: ProtoVersion): RepresentativeProtocolVersion[ValueClass]
    Definition Classes
    HasSupportedProtoVersions
  22. def protocolVersionRepresentativeFor(protocolVersion: ProtocolVersion): RepresentativeProtocolVersion[ValueClass]
    Definition Classes
    HasSupportedProtoVersions
  23. def supportedProtoVersion[Proto <: GeneratedMessage](p: GeneratedMessageCompanion[Proto])(fromProto: (Context, Proto) => ParsingResult[ValueClass]): Deserializer
    Attributes
    protected
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. object LegacyProtoConverter extends Serializable
    Definition Classes
    HasSupportedProtoVersions
  30. object SupportedProtoVersions extends Serializable
    Definition Classes
    HasSupportedProtoVersions
  31. object VersionedProtoConverter extends Serializable
    Definition Classes
    HasSupportedProtoVersions

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from HasProtocolVersionedWrapperCompanion[ValueClass]

Inherited from HasSupportedProtoVersions[ValueClass]

Inherited from AnyRef

Inherited from Any

Ungrouped