object ActionDescription extends HasProtocolVersionedCompanion[ActionDescription] with Serializable
- Alphabetic
- By Inheritance
- ActionDescription
- Serializable
- HasProtocolVersionedCompanion
- HasProtocolVersionedWrapperCompanion
- HasSupportedProtoVersions
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- case class CreateActionDescription(contractId: LfContractId, seed: LfHash, version: LfTransactionVersion)(representativeProtocolVersion: RepresentativeProtocolVersion[ActionDescription]) extends ActionDescription with Product with Serializable
- type DataByteString = ByteString
- Definition Classes
- HasProtocolVersionedWrapperCompanion
- type Deserializer = (DataByteString) => ParsingResult[ActionDescription]
- Definition Classes
- HasProtocolVersionedCompanion → HasProtocolVersionedWrapperCompanion → HasSupportedProtoVersions
- final case class ExerciseActionDescription extends ActionDescription with Product with Serializable
- Exceptions thrown
InvalidActionDescriptionif thechosen_valuecannot be serialized
- case class FetchActionDescription(inputContractId: LfContractId, actors: Set[LfPartyId], byKey: Boolean, version: LfTransactionVersion)(representativeProtocolVersion: RepresentativeProtocolVersion[ActionDescription]) extends ActionDescription with NoCopy with Product with Serializable
- case class InvalidActionDescription(message: String) extends RuntimeException with PrettyPrinting with Product with Serializable
- case class LookupByKeyActionDescription extends ActionDescription with Product with Serializable
- type OriginalByteString = ByteString
- Definition Classes
- HasProtocolVersionedWrapperCompanion
- type Serializer = (ActionDescription) => ByteString
- Definition Classes
- HasSupportedProtoVersions
- 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
- 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
- case class SupportedProtoVersions extends Product with Serializable
- Definition Classes
- HasSupportedProtoVersions
- 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
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()
- def deserializeForVersion(rpv: RepresentativeProtocolVersion[ActionDescription], deserializeLegacyProto: (Deserializer) => ParsingResult[ActionDescription], deserializeVersionedProto: => ParsingResult[ActionDescription]): ParsingResult[ActionDescription]
- Attributes
- protected
- Definition Classes
- HasProtocolVersionedWrapperCompanion
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def fromByteArray(bytes: Array[Byte]): ParsingResult[ActionDescription]
- Definition Classes
- HasProtocolVersionedCompanion
- def fromByteString(protocolVersion: ProtocolVersion)(bytes: OriginalByteString): ParsingResult[ActionDescription]
Use this method when deserializing bytes for classes that have a legacy proto converter to explicitly set the version to use for the deserialization.
Use this method when deserializing bytes for classes that have a legacy proto converter to explicitly set the version to use for the deserialization.
- protocolVersion
protocol version of the bytes to be deserialized
- bytes
data
- Definition Classes
- HasProtocolVersionedCompanion
- def fromByteString(bytes: OriginalByteString): ParsingResult[ActionDescription]
- Definition Classes
- HasProtocolVersionedCompanion
- def fromLfActionNode(actionNode: LfActionNode, seedO: Option[LfHash], protocolVersion: ProtocolVersion): Either[InvalidActionDescription, ActionDescription]
Extracts the action description from an LF node and the optional seed.
Extracts the action description from an LF node and the optional seed.
- seedO
Must be set iff
nodeis a com.digitalasset.canton.protocol.LfNodeCreate or com.digitalasset.canton.protocol.LfNodeExercises.
- def fromProtoVersioned(proto: VersionedMessage[ActionDescription]): ParsingResult[ActionDescription]
- Definition Classes
- HasProtocolVersionedCompanion
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- implicit def hasVersionedWrapperGetResult(implicit getResultByteArray: GetResult[Array[Byte]]): GetResult[ActionDescription]
- Definition Classes
- HasProtocolVersionedCompanion
- implicit def hasVersionedWrapperGetResultO(implicit getResultByteArray: GetResult[Option[Array[Byte]]]): GetResult[Option[ActionDescription]]
- Definition Classes
- HasProtocolVersionedCompanion
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- lazy val 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
- Definition Classes
- ActionDescription → HasProtocolVersionedWrapperCompanion → HasSupportedProtoVersions
- 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()
- 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
- def protoVersionFor(protocolVersion: RepresentativeProtocolVersion[ActionDescription]): ProtoVersion
Return the Proto version corresponding to the representative protocol version
Return the Proto version corresponding to the representative protocol version
- Definition Classes
- HasSupportedProtoVersions
- def protocolVersionRepresentativeFor(protoVersion: ProtoVersion): RepresentativeProtocolVersion[ActionDescription]
- Definition Classes
- HasSupportedProtoVersions
- def protocolVersionRepresentativeFor(protocolVersion: ProtocolVersion): RepresentativeProtocolVersion[ActionDescription]
- Definition Classes
- HasSupportedProtoVersions
- def readFromFile(inputFile: String): Either[String, ActionDescription]
- Definition Classes
- HasProtocolVersionedCompanion
- def serializeChosenValue(chosenValue: Value, transactionVersion: LfTransactionVersion): Either[String, ByteString]
- def supportedProtoVersion[Proto <: GeneratedMessage](p: GeneratedMessageCompanion[Proto])(fromProto: (Proto) => ParsingResult[ActionDescription]): Deserializer
- Attributes
- protected
- Definition Classes
- HasProtocolVersionedCompanion
- val supportedProtoVersions: SupportedProtoVersions
Proto versions that are supported by
fromProtoVersionedandfromByteStringSee the helpersupportedProtoVersionbelow to define aParser.Proto versions that are supported by
fromProtoVersionedandfromByteStringSee the helpersupportedProtoVersionbelow to define aParser.- Definition Classes
- ActionDescription → HasSupportedProtoVersions
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def tryFromLfActionNode(actionNode: LfActionNode, seedO: Option[LfHash], protocolVersion: ProtocolVersion): ActionDescription
- def tryReadFromFile(inputFile: String): ActionDescription
- Definition Classes
- HasProtocolVersionedCompanion
- 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])
- object ExerciseActionDescription extends Serializable
- object LookupByKeyActionDescription extends Serializable
- object LegacyProtoConverter extends Serializable
- Definition Classes
- HasSupportedProtoVersions
- object SupportedProtoVersions extends Serializable
- Definition Classes
- HasSupportedProtoVersions
- object VersionedProtoConverter extends Serializable
- Definition Classes
- HasSupportedProtoVersions